Disponible en: el plan EnterpriseDónde encontrarlo: Settings en el menú del nombre de la organización, en la parte superior izquierda de la pantalla > Account > API Keys
Descripción general
Para autenticar tus solicitudes a la API, necesitas una clave de API. Esta clave identifica y autoriza tus solicitudes, lo que garantiza que solo los usuarios autorizados puedan acceder a los recursos. Tu clave de API es un token de acceso personal vinculado a tu cuenta de usuario. Proporciona acceso a los datos de las organizaciones a las que perteneces, incluidas las categorías, las regiones y los informes de categorías.Cómo obtener tu clave de API
1
Ve al portal de generación de claves de API
- Inicia sesión en la plataforma. Selecciona el nombre de tu organización en la parte superior izquierda de la pantalla y luego selecciona Settings.
- En la barra lateral izquierda, en Account, selecciona API Keys. Se mostrará tu portal de generación de claves y una tabla con tus claves.
2
Configura y crea tu clave
- En el banner Create API Key, introduce un nombre de clave y selecciona el período de Expiration.
- Selecciona Create API Key para generar la clave.
Por seguridad, no podrás volver a recuperar tu clave. Copia y guarda tu clave de API de forma segura antes de continuar.
Métodos de autenticación
Puedes autenticar tus solicitudes con cualquiera de los métodos siguientes:Autenticación por encabezado (recomendada)
Incluye tu clave de API en el encabezadoX-API-Key:
Alcance y permisos de la clave de API
Tu clave de API proporciona acceso a:- Datos de la organización: los datos de las organizaciones a las que perteneces
- Categorías: las categorías de datos disponibles y sus metadatos
- Datos regionales: información y filtros basados en la ubicación
- Informes: informes y análisis generados para tus categorías
- Datos sin procesar: datos sin procesar dentro de las categorías a las que tienes acceso
Propiedad de la clave
- Las claves te pertenecen: cada clave de API está vinculada al usuario que la creó. Todas las solicitudes realizadas con la clave se atribuyen a ese usuario, incluso cuando las envía otra persona.
- Las claves son privadas para su propietario: Profound solo almacena un hash de cada clave, por lo que nadie, ni siquiera los administradores de la organización, puede ver una clave después de crearla.
- El acceso depende de la membresía: si se te elimina de una organización, tu clave se mantiene, pero ya no llega a los datos de esa organización. Para que una clave deje de funcionar por completo, revócala en la página API Keys.
Prácticas recomendadas de seguridad
- Mantén las claves en privado: tu clave de API es información confidencial. Nunca la compartas públicamente ni la confirmes en el control de versiones. Guárdala de forma segura y trátala como una contraseña.
- Usa variables de entorno: guarda las claves en variables de entorno o en archivos de configuración seguros.
- Rótalas con regularidad: considera rotar tus claves de API periódicamente para mejorar la seguridad.
- Supervisa el uso: revisa el uso de tu API con regularidad para detectar cualquier acceso no autorizado.