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

Desarrolladores

Construye sobre HelpFalcon

Una API REST con documento OpenAPI, una API compatible con Zendesk para los clientes que ya tienes, webhooks firmados, el SDK del messenger y apps de la barra lateral.

Referencia de la API Obtener un token

162 operaciones REST
API de Zendesk en /zd/api/v2
En todos los planes de pago

Tu primera petición

curl https://yourcompany.helpfalcon.com/api/tickets?itemsPerPage=5 \
  -H "Authorization: Bearer $HELPFALCON_TOKEN" \
  -H "Accept: application/json"

URL base: la dirección de tu espacio de trabajo. API REST en /api, API compatible con Zendesk en /zd/api/v2.

Inicio rápido

1
Crea un token
En tu espacio de trabajo abre Admin Center, Integrations, API tokens y crea un token con el scope read.
2
Llama a la API
Envíalo como bearer token, como en la petición de arriba. Las respuestas son JSON; las colecciones están paginadas.
3
Reacciona a los cambios
Añade un webhook como acción de un disparador para recibir callbacks firmados cuando cambian los tickets.

Los límites de peticiones por plan están en la página de límites de uso.

Explora la plataforma

Autenticación Tokens de API con scope de lectura o escritura, enviados como bearer token. Referencia de la API REST 162 operaciones en 39 recursos, generadas a partir de nuestro documento OpenAPI. API compatible con Zendesk Conserva tus clientes de la API de Zendesk: cambia la URL base y el token. Webhooks Entregas firmadas con HMAC, con reintentos y registro de entregas. SDK del messenger Inserta el messenger, llama a zE(), identifica visitantes con un JWT. Apps de la barra lateral Las apps creadas con Zendesk App Framework v2 funcionan en la barra lateral del ticket. Conector de datos de clientes Muestra datos de tus propios sistemas junto a cada ticket. Registro de cambios de la API Qué cambió en la API, lo más reciente primero. Versiones y retirada La API solo crece y nada se retira con menos de 12 meses de aviso. Direcciones IP Las direcciones desde las que llegan nuestros webhooks y conectores, para tu firewall.

Librerías cliente

Uso y colección de Postman

Generadas a partir del mismo documento OpenAPI que la referencia. Reintentan ante límites de uso, lanzan los problem details de la API y recorren las colecciones por ti.

PHPCliente generado

composer require helpfalcon/helpfalcon-php

Ejemplo de uso

Node.jsCliente generado

npm install @helpfalcon/api

Ejemplo de uso

PythonCliente generado

pip install helpfalcon

Ejemplo de uso

Recursos de la API REST

Los 39 recursos