Introdução
Integre seu sistema ao fluxo de tickets do HSDesk. Crie e consulte tickets, responda como cliente e receba eventos em tempo real via webhooks.
A API Pública do HSDesk permite que o sistema de uma empresa parceira (CRM, loja, chat, ERP) converse com o HSDesk em duas direções:
- Entrada: uma API REST
v1, autenticada por HSDesk Key, para criar tickets, consultá-los, responder como cliente e listar atendentes. - Saída: webhooks assinados (HMAC-SHA256), entregues de forma assíncrona, que avisam seu sistema quando algo muda no ticket (resposta do atendente, mudança de status, resolução).
Só produção por enquanto
O HSDesk ainda não tem ambiente de homologação: a base é a de produção
(https://api.hsdesk.com.br). Você pode testar criando tickets na produção da sua organização e
excluí-los depois pelo painel. Comece pelo Guia rápido.
Documentação interativa
A seção Referência da API traz cada endpoint com esquema de requisição/resposta e um playground para testar as chamadas direto do navegador.
Visão geral
| Base URL | https://api.hsdesk.com.br/api/v1 |
| Autenticação (entrada) | HSDesk Key via header Authorization (Bearer ou Basic) |
| Formato | JSON (Content-Type: application/json) |
| Organização | Resolvida pela credencial enviada na requisição |
| Webhooks (saída) | HTTP POST assinado com HMAC-SHA256 |
| Rate limit | 120 requisições/minuto por credencial (padrão) |
Trocar a base URL
Os exemplos usam a base de produção https://api.hsdesk.com.br. Se você integra com outro
host/ambiente HSDesk, basta trocar a base nas chamadas. Na Referência, o playground
permite escolher o servidor usado no "Try it".
Envelope padrão
Toda resposta da API (sucesso ou erro) segue o mesmo envelope:
{
"success": true,
"message": "Ticket criado.",
"data": { },
"errors": null
}success:true/false.message: mensagem legível.data: o recurso (objeto ou lista paginada), ounull.errors:nullem sucesso; em falha, traz{ "field": "...", "message": "..." }.
Por onde começar
Autenticação
Formato da HSDesk Key e como enviá-la em cada requisição.
Credenciais no painel
Gerar a chave e cadastrar webhooks pela tela de configuração.
Endpoints v1
Criar, listar e consultar tickets; responder como cliente.
Webhooks
Eventos disponíveis, verificação da assinatura e entregas.
Guia rápido
Da credencial à primeira integração em poucos passos.
Erros & rate limit
Códigos de status, formato de erro e limites.