HSDesk APIHSDesk / API Pública

Erros & rate limit

Formato de erro, códigos de status HTTP e limite de requisições.

Formato de erro

Erros seguem o mesmo envelope das respostas de sucesso, com success: false e detalhes em errors:

{
  "success": false,
  "message": "A validação falhou.",
  "data": null,
  "errors": { "field": "assunto", "message": "O campo assunto é obrigatório." }
}

Códigos de status

StatusSignificadoCausa típica
400Requisição inválidaJSON malformado / parâmetros inválidos.
401Não autenticadoHSDesk Key ausente, inválida ou revogada.
404Não encontradoRecurso inexistente.
422Regra de negócioEx.: payload válido, mas não foi possível resolver o contato.
429Rate limitExcedeu o limite por credencial.

Rate limit

O limite é por credencial: padrão 120 requisições por minuto. Ao exceder, a API responde 429. Implemente backoff e reduza a frequência das chamadas ao receber 429.

On this page