API compatible con Zendesk

Muchos equipos tienen sistemas propios que hablan con la API de Zendesk: servicios internos con los SDK oficiales, herramientas de back-office, widgets de FAQ en otros sitios. HelpFalcon responde a esas peticiones en /zd/api/v2 con las mismas formas de petición y respuesta, así que solo cambian la URL base y el token de API.

Las escrituras de tickets pasan por el flujo normal de tickets: una auditoría por petición, se ejecutan disparadores y SLA, y el autor de la auditoría es el propietario del token.

Cambiar un cliente

1. Crea un token de API para el usuario de integración en Admin Center, Integrations, API tokens, con el scope write.
2. Apunta el cliente a tu espacio de trabajo:

Cliente	Ajuste
HTTP simple	URL base https://yourcompany.helpfalcon.com/zd/api/v2
C# ZendeskApi.Client	Subdominio yourcompany.helpfalcon.com/zd, usuario {email}/token, el token de HelpFalcon
C# ZendeskApi_v2	new ZendeskApi("https://yourcompany.helpfalcon.com/zd/api/v2", email, token)
PHP zendesk_api_client_php	$client->setApiBasePath('zd/api/v2/') y el host de tu espacio de trabajo
Lectores del centro de ayuda	URL base https://yourcompany.helpfalcon.com/zd

3. Autentícate como antes: Basic {email}/token:{token}, Authorization: Bearer {token} o credenciales de cliente OAuth en POST /zd/oauth/tokens con client_id = el correo del propietario del token y client_secret = el token. La autenticación con contraseña no está admitida.

Cada ruta .json también responde sin .json. Los enlaces con la forma {BaseUrl}agent/tickets/{id} redirigen al ticket en el espacio de agentes.

Ids

Los registros importados conservan sus ids de Zendesk: números de ticket e ids de usuarios, organizaciones, grupos y centro de ayuda. Los registros creados en HelpFalcon reciben ids nuevos por encima del mayor importado.

Endpoints

Área	Endpoints
Tickets	GET/POST tickets, GET/PUT/DELETE tickets/{id}, GET tickets/show_many, PUT tickets/update_many, DELETE tickets/destroy_many, GET tickets/count, GET tickets?external_id=
Comentarios y auditorías	GET tickets/{id}/comments, GET tickets/{id}/audits, GET tickets/{id}/audits/{audit_id}
Etiquetas	GET/POST/PUT/DELETE tickets/{id}/tags
Subidas	POST uploads?filename= (el token adjunta los archivos al siguiente comentario)
Trabajos	GET job_statuses/{id} para actualizaciones y borrados masivos
Búsqueda	GET search, GET search/count, con la sintaxis de búsqueda de Zendesk
Exportación incremental	GET incremental/tickets/cursor, GET incremental/users/cursor y las variantes por tiempo
Usuarios	GET/POST users, GET users/{id}, GET users/me, POST users/create_or_update, GET users/search
Organizaciones, grupos	GET organizations, GET organizations/{id}, GET groups, GET groups/{id}
Centro de ayuda (público)	GET help_center/{locale}/sections, .../sections/{id}/articles, .../articles/{id}, GET help_center/articles/search

Las operaciones masivas devuelven un trabajo, como en Zendesk. Las actualizaciones en conflicto con safe_update devuelven 409.

Qué tan estable es

Las formas de esta página están congeladas: aquí solo añadimos endpoints y campos, y nunca cambiamos una respuesta que analice un cliente escrito para Zendesk. Nada se retira con menos de 12 meses de aviso. Consulta versiones y retirada.

Lo que no se mueve con una URL base

Las integraciones que no escribiste tú y que están fijadas a *.zendesk.com (por ejemplo la app de Zendesk para Zapier, el conector de Zendesk de Fivetran o los SDK móviles de Zendesk) no se pueden apuntar a HelpFalcon. Usa en su lugar la API REST, los webhooks o el messenger. Consulta cambiar desde Zendesk.

Zendesk es una marca de Zendesk, Inc. HelpFalcon no está afiliado a Zendesk, Inc. ni cuenta con su respaldo o patrocinio; la API compatible existe para la interoperabilidad con tu propio software.