Contacto
Español

Autenticación

Autentica las peticiones a la API con un token de API personal, con scope de lectura o escritura.

Traducido para tu comodidad. El código, los nombres de campos y la referencia de la API siguen en inglés. Versión en inglés

Cada petición a la API se autentica con un token de API. Un token actúa como el miembro del equipo al que pertenece: puede ver y cambiar exactamente lo que esa persona puede en el espacio de agentes, limitado además por el scope del token.

Crear un token

  1. Abre Admin Center, Integrations, API tokens.
  2. Elige New token, dale un nombre que diga qué lo usa (por ejemplo «Billing sync») y elige un scope.
  3. Copia el token. Empieza por desk_ y solo se muestra una vez.
ScopePermite
readSolo peticiones GET
writeTodos los métodos: GET, POST, PUT, PATCH, DELETE

Crea un token distinto para cada integración, a nombre de un usuario de integración dedicado cuando puedas. Así, revocarlo solo afecta a esa integración.

Enviar el token

GET /api/tickets HTTP/1.1
Host: yourcompany.helpfalcon.com
Authorization: Bearer desk_xxxxxxxxxxxxxxxxxxxx
Accept: application/json

Las respuestas son JSON (application/json) o JSON-LD (application/ld+json) según la cabecera Accept. Las actualizaciones parciales usan PATCH con Content-Type: application/merge-patch+json.

Errores

EstadoSignificado
401Token ausente, no válido, caducado o revocado
402La función no forma parte de tu plan (plan_required)
403El propietario del token no puede hacer esto, o un token read intentó escribir
422La validación falló; el cuerpo lista los campos
429Límite de uso alcanzado, consulta los límites de uso

Los errores usan problem details RFC 9457 (application/problem+json).

API compatible con Zendesk

La API compatible con Zendesk acepta los mismos tokens con los estilos de autenticación de Zendesk: Basic auth con {email}/token:{token}, un bearer token o credenciales de cliente OAuth.