API compatível com Zendesk

Muitas equipes têm sistemas próprios que conversam com a API do Zendesk: serviços internos com os SDKs oficiais, ferramentas de back-office, widgets de FAQ em outros sites. O HelpFalcon responde a essas requisições em /zd/api/v2 com os mesmos formatos de requisição e resposta, então só mudam a URL base e o token de API.

As gravações de tickets passam pelo fluxo normal de tickets: uma auditoria por requisição, gatilhos e SLAs são executados, e o autor da auditoria é o dono do token.

Trocar um cliente

1. Crie um token de API para o usuário de integração em Admin Center, Integrations, API tokens, com o scope write.
2. Aponte o cliente para o seu espaço de trabalho:

Cliente	Configuração
HTTP simples	URL base https://yourcompany.helpfalcon.com/zd/api/v2
C# ZendeskApi.Client	Subdomínio yourcompany.helpfalcon.com/zd, usuário {email}/token, o token do 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/') e o host do seu espaço de trabalho
Leitores da central de ajuda	URL base https://yourcompany.helpfalcon.com/zd

3. Autentique-se como antes: Basic {email}/token:{token}, Authorization: Bearer {token} ou credenciais de cliente OAuth em POST /zd/oauth/tokens com client_id = o e-mail do dono do token e client_secret = o token. Autenticação por senha não é suportada.

Todo caminho .json também responde sem .json. Links no formato {BaseUrl}agent/tickets/{id} redirecionam para o ticket no espaço de agentes.

Ids

Registros importados mantêm os ids do Zendesk: números de ticket e ids de usuários, organizações, grupos e central de ajuda. Registros criados no HelpFalcon recebem ids novos acima do maior 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=
Comentários e auditorias	GET tickets/{id}/comments, GET tickets/{id}/audits, GET tickets/{id}/audits/{audit_id}
Tags	GET/POST/PUT/DELETE tickets/{id}/tags
Uploads	POST uploads?filename= (o token anexa os arquivos ao próximo comentário)
Jobs	GET job_statuses/{id} para atualizações e exclusões em massa
Busca	GET search, GET search/count, com a sintaxe de busca do Zendesk
Exportação incremental	GET incremental/tickets/cursor, GET incremental/users/cursor e as variantes por tempo
Usuários	GET/POST users, GET users/{id}, GET users/me, POST users/create_or_update, GET users/search
Organizações, grupos	GET organizations, GET organizations/{id}, GET groups, GET groups/{id}
Central de ajuda (pública)	GET help_center/{locale}/sections, .../sections/{id}/articles, .../articles/{id}, GET help_center/articles/search

Operações em massa devolvem um job, como no Zendesk. Atualizações conflitantes com safe_update devolvem 409.

Quão estável é

Os formatos desta página estão congelados: aqui só adicionamos endpoints e campos, e nunca mudamos uma resposta que um cliente escrito para o Zendesk interpreta. Nada é removido com menos de 12 meses de aviso. Veja versionamento e descontinuação.

O que não muda com uma URL base

Integrações que você não escreveu e que estão fixas em *.zendesk.com (por exemplo o app do Zendesk para Zapier, o conector Zendesk da Fivetran ou os SDKs móveis do Zendesk) não podem ser apontadas para o HelpFalcon. Use a API REST, os webhooks ou o messenger. Veja migrar do Zendesk.

Zendesk é uma marca da Zendesk, Inc. O HelpFalcon não é afiliado, endossado nem patrocinado pela Zendesk, Inc.; a API compatível existe para interoperabilidade com o seu próprio software.