DOM360

Erros

Toda falha da API responde o mesmo envelope, qualquer que seja o status. Trate pelo campo code.

{
  "error": {
    "code": "AGENT_NOT_FOUND",
    "message": "Agente não encontrado.",
    "details": {},
    "request_id": "req_…"
  }
}
CampoO que é
codeO código estável da falha. É o contrato: compare por igualdade.
messageFrase curta em português, para gente. Pode mudar; nunca use como chave.
detailsDetalhe estruturado, {} quando não há. Na validação, {"field": "name", "reason": "required"}.
request_idO id desta requisição, igual ao cabeçalho x-request-id. Mande-o ao suporte.

Status e códigos

SituaçãoStatuscode
Corpo, parâmetro ou JSON inválido422VALIDATION_ERROR
Idempotency-Key obrigatória ausente400IDEMPOTENCY_KEY_REQUIRED
Sem credencial ou credencial recusada401UNAUTHORIZED
Sem a capacidade exigida403FORBIDDEN
Operação exige sessão403SESSION_REQUIRED
Não existe ou está fora do seu alcance404<RECURSO>_NOT_FOUND
Conflito de unicidade ou concorrência409CONFLICT
Transição de estado não permitida409INVALID_STATE_TRANSITION
Corpo acima do limite413PAYLOAD_TOO_LARGE
Cliente bloqueado por cobrança402TENANT_BLOCKED
Limite de requisições429RATE_LIMITED (respeite Retry-After)
Provedor externo indisponível503INTEGRATION_UNAVAILABLE
Serviço indisponível503SERVICE_UNAVAILABLE
Tempo esgotado504TIMEOUT
Falha inesperada500INTERNAL_ERROR

O que fazer em cada caso

  • 4xx: em geral, corrija o pedido antes de repeti-lo. Em 409 IDEMPOTENCY_IN_PROGRESS e 429, espere; em 409 IDEMPOTENCY_REPLAY_UNAVAILABLE, consulte o recurso quando disponível, sem tentar recuperar a resposta original pela mesma chave.
  • 5xx e falhas de rede: se a operação declarar Idempotency-Key, repita com a mesma chave; não presuma que a resposta original possa ser reproduzida. Confira os parâmetros da operação e veja Repetição segura.

Nesta página