Autenticarse con una clave API

Ver como Markdown Abrir en ChatGPT Abrir en Claude

La API de Pristo identifica a tu sistema mediante una clave API que envías en el encabezado X-API-Key de cada solicitud. La clave se crea en la aplicación de Pristo CX, en Gestión > Claves API, y pertenece al programa que está seleccionado cuando la creas.

Antes de empezar

Rol: tienes el rol Administrador de la cuenta o Administrador del programa en el programa. Consulta Roles y permisos.
Plan: Estándar o Pro. Claves API no aparece en el plan Gratis.
Programa: cambia al programa al que pertenecerá la clave seleccionando el nombre del programa en el encabezado de la aplicación, como se explica en Navegar por la aplicación de Pristo CX. Los eventos que envíes con la clave van a la población de este programa. Consulta el glosario.

Pasos

Boceto de la página que muestra las claves API del programa. El marcador 1 está en la pestaña de gestión del menú principal, el marcador 2 en el elemento de claves API del menú lateral y el marcador 3 en el botón que agrega una clave, arriba a la derecha. Cada fila muestra el nombre de la clave, sus primeros caracteres, si está activa y cuándo se creó, con un menú al final de la fila.

Selecciona Gestión en el menú principal.
Selecciona Claves API.
Selecciona Agregar.
Escribe en Nombre un nombre que indique qué sistema usa la clave, por ejemplo Example Coffee CRM.
Selecciona Crear.
Selecciona Copiar código y guarda la clave en el almacén de secretos de tu sistema.
Cierra el cuadro de diálogo.

Resultado

La clave aparece en la lista con su Nombre, los primeros 24 caracteres en Prefijo, Activo con el valor Sí y su Hora de creación. Una clave tiene la forma pristo_live_pk_ seguida de 32 letras y dígitos.

Envía la clave con cada solicitud:

curl -X POST "https://api.pristo.io/v1/events/send" \
  -H "X-API-Key: $PRISTO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type": "purchase", "contact": {"id": "CUST-1042", "email": "dana@example.com"}}'

Gestionar las claves

Abre el menú al final de la fila de una clave:

Desactivar detiene la clave. La siguiente solicitud que la use recibe 401 Unauthorized.
Activar vuelve a activar una clave inactiva. Una clave activada cuenta para el límite de 10 claves activas, y la cuenta debe tener el plan Estándar o Pro.
Eliminar solo aparece en una clave inactiva y la quita de la lista de forma definitiva.

Para cambiar el nombre de una clave, selecciona el lápiz que está junto a su nombre. Para rotar una clave, crea una nueva, cambia tu sistema para que use la nueva y luego desactiva y elimina la anterior.

Límites

Hasta 10 claves API activas por cuenta, sumando todos los programas. Las claves inactivas no cuentan.
El nombre de una clave tiene de 1 a 50 caracteres.
La lista solo muestra las claves del programa seleccionado.

Solución de problemas

No encuentro dónde crear una clave. Si Gestión no aparece en el menú principal, tienes el rol Usuario del programa en este programa: pide ayuda a un administrador de la cuenta o a un administrador del programa. Si Gestión no tiene Claves API, la cuenta tiene el plan Gratis.

Todas las solicitudes devuelven 401. Falta el encabezado X-API-Key, la clave es incorrecta o la clave se desactivó o se eliminó. Revisa el valor de Activo de la clave en la lista y el nombre del encabezado.

Una solicitud devuelve 400 con Value is invalid. El valor del encabezado tiene menos de 24 caracteres. Vuelve a copiar la clave completa. Consulta Errores de la API.

No puedo crear ni activar una clave. La cuenta ya tiene 10 claves activas o tiene el plan Gratis, que no incluye acceso a la API. Usa Desactivar en una clave que ya no necesites o pide a un administrador de la cuenta que pase a un plan superior.