Autenticação
A API de entrada usa HSDesk Keys, enviadas no header Authorization como Bearer ou Basic.
A API de entrada (/api/v1/*) usa chaves de aplicação (HSDesk Keys): não é
usuário/senha nem JWT. A chave identifica a organização e nada mais.
Formato da HSDesk Key
hsk_test_b4txIOsyknxHwEnrcW57RD14zjnhVdaC0PFyGzjq
└┬┘ └─┬┘ └──────────────────┬──────────────────┘
│ │ └ 40 caracteres aleatórios
│ └ ambiente: "live" em produção, "test" nos demais
└ prefixo (padrão "hsk")- O ambiente (
live/test) é derivado do ambiente do servidor. Não é possível gerar uma chavelivefora de produção, uma proteção contra acidentes. É apenas informativo para você distinguir as credenciais. - No banco, o HSDesk guarda somente o
sha256do token e um prefixo curto (os primeiros caracteres, para exibição no painel). O token completo é mostrado uma única vez, na criação.
A chave é exibida uma única vez
Guarde a HSDesk Key em local seguro assim que ela for gerada. Se perder, gere outra: o HSDesk não consegue exibi-la novamente.
Enviando a credencial
Envie a HSDesk Key no header Authorization, em um dos dois formatos:
Authorization: Bearer hsk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxA chave vai como usuário, com senha vazia:
Authorization: Basic base64("hsk_live_xxxx:")Exemplo de requisição autenticada:
curl https://api.hsdesk.com.br/api/v1/tickets \
-H "Authorization: Bearer hsk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"401: credencial inválida
Credencial ausente, inválida ou revogada resulta em 401. Confira o prefixo
(hsk_live_/hsk_test_) e se a chave não foi revogada no painel.
Rate limit
As chamadas são limitadas por credencial: por padrão 120 requisições por minuto.
Ao exceder, a API responde 429 Too Many Requests. Veja Erros & rate limit.
Próximo passo
Para gerar sua HSDesk Key (e cadastrar webhooks), use a tela de configuração do painel; veja Credenciais no painel.