Saltar para o conteúdo principal

Erros e comportamento de repetição

Respostas sem sucesso usam este envelope:
{
  "error": {
    "code": "SOME_CODE",
    "message": "Human-readable explanation",
    "issues": []
  }
}

Orientações para repetição

  • Repita falhas de transporte.
  • Repita escritas idempotentes com a mesma Idempotency-Key.
  • Releia o estado durável após trabalho assíncrono em vez de assumir que a primeira resposta está completa.

Regras práticas

  • Trate falhas no lado do servidor como candidatas à repetição somente quando a escrita original usou uma chave de idempotência estável.
  • Trate URLs novas de download de exportação como temporárias e releia-as a partir de GET /exports/{exportId} quando necessário.
  • Se uma mutação já estiver em andamento ou entrar em conflito com o estado atual, inspecione o code retornado e repita apenas quando a operação ainda for logicamente segura.

Clientes legíveis por máquina

O SDK e o CLI de Node.js fornecidos normalizam erros em objetos estruturados com:
  • code
  • message
  • status
  • retryable
Isso torna seguro ramificar a lógica de automação sem analisar strings de formato livre.