Autenticación

La API de Platica utiliza autenticación basada en tokens Bearer. Debes incluir tu API Key en el header Authorization de todas las peticiones HTTP.

Formato del header

Authorization: Bearer pl_key_xxxxxxxxxxxxx

Obtener tu API Key

Puedes generar tu API Key directamente desde el dashboard de Platica, sin necesidad de contactar al equipo de soporte.

Abre la configuración — Desde el dashboard de Platica, dirígete a Configuración y selecciona la sección API Keys.
Crea una nueva API Key — Haz clic en Crear nueva API Key e ingresa un nombre descriptivo para identificarla.
Guarda tu API Key — La API Key se mostrará una única vez. Cópiala y guárdala en un lugar seguro; no podrás verla de nuevo.
Configura tus peticiones — Incluye la API Key en el header de todas tus peticiones a la API.

Ejemplo de petición autenticada

curl -X GET "https://api.platica.mx/v1/agents" \
  -H "Authorization: Bearer pl_key_xxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

Consideraciones importantes

Advertencia

Mantén tu API Key segura. No la expongas en código público, repositorios o aplicaciones del lado del cliente. Si sospechas que ha sido comprometida, contacta inmediatamente a integraciones@platica.mx .

Tu API Key tiene acceso únicamente al workspace desde el que fue creada. Esto significa que:

Solo puedes gestionar agentes, clientes y conversaciones dentro de ese workspace.
No tendrá acceso a otros workspaces, aunque tu cuenta forme parte de ellos.
Si necesitas acceder a varios workspaces vía API, deberás generar una API Key en cada uno.

Errores de autenticación

Si tu API Key es inválida o no está presente, recibirás un error 401 Unauthorized:

{
  "code": 401,
  "error": "Unauthorized",
  "details": "Invalid or missing API key"
}

Consulta la sección de Errores para más información sobre el manejo de errores.

Anterior Bienvenida a la API Siguiente Introducción