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

  1. Solicita acceso — Envía un correo a integraciones@platica.mx indicando tu cuenta de usuario y el caso de uso.

  2. Recibe tu API Key — El equipo de Platica te proporcionará una API Key vinculada a tu cuenta.

  3. 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

Tu API Key está vinculada a tu cuenta de usuario y te otorga acceso a todos los workspaces donde tengas permisos asignados. Esto significa que:

  • Puedes gestionar agentes, clientes y conversaciones dentro de tus workspaces autorizados.
  • No podrás acceder a recursos de workspaces donde no tengas permisos.
  • Los permisos específicos dependen de tu rol dentro de cada workspace.

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.