Traduzido para sua conveniência. Código, nomes de campos e a referência da API continuam em inglês. Versão em inglês

Desenvolvedores

Construa sobre o HelpFalcon

Uma API REST com documento OpenAPI, uma API compatível com Zendesk para os clientes que você já tem, webhooks assinados, o SDK do messenger e apps da barra lateral.

Referência da API Obter um token

162 operações REST
API do Zendesk em /zd/api/v2
Em todos os planos pagos

Sua primeira requisição

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

URL base: o endereço do seu espaço de trabalho. API REST em /api, API compatível com Zendesk em /zd/api/v2.

Início rápido

1
Crie um token
No seu espaço de trabalho abra Admin Center, Integrations, API tokens e crie um token com o scope read.
2
Chame a API
Envie-o como bearer token, como na requisição acima. As respostas são JSON; as coleções são paginadas.
3
Reaja às mudanças
Adicione um webhook como ação de gatilho para receber callbacks assinados quando os tickets mudam.

Os limites de requisições por plano estão na página de limites de taxa.

Explore a plataforma

Autenticação Tokens de API com scope de leitura ou escrita, enviados como bearer token. Referência da API REST 162 operações em 39 recursos, geradas a partir do nosso documento OpenAPI. API compatível com Zendesk Mantenha seus clientes da API do Zendesk: troque a URL base e o token. Webhooks Entregas assinadas com HMAC, com novas tentativas e registro de entregas. SDK do messenger Incorpore o messenger, chame zE(), identifique visitantes com um JWT. Apps da barra lateral Apps feitos com o Zendesk App Framework v2 rodam na barra lateral do ticket. Conector de dados de clientes Mostre dados dos seus próprios sistemas ao lado de cada ticket. Registro de mudanças da API O que mudou na API, o mais recente primeiro. Versionamento e descontinuação A API só cresce, e nada é removido com menos de 12 meses de aviso. Endereços IP Os endereços de onde vêm nossos webhooks e conectores, para o seu firewall.

Bibliotecas cliente

Uso e coleção do Postman

Geradas a partir do mesmo documento OpenAPI da referência. Elas repetem a requisição em limites de taxa, lançam os problem details da API e percorrem as coleções por você.

PHPCliente gerado

composer require helpfalcon/helpfalcon-php

Exemplo de uso

Node.jsCliente gerado

npm install @helpfalcon/api

Exemplo de uso

PythonCliente gerado

pip install helpfalcon

Exemplo de uso

Recursos da API REST

Todos os 39 recursos