Erros e paginação da API
Inspecione o status HTTP e o corpo da resposta quando uma requisição falhar. Mantenha o corpo privado se contiver dados da conta, do código-fonte ou do aplicativo.
Códigos de status
| Status | O que verificar |
|---|---|
| 400 | Campos necessários, codificação do corpo, IDs de recursos, valores de consulta e X-Tenant-ID. |
| 401 | Token ausente, expirado ou incompatível. Obtenha um novo token de diagnóstico quando necessário. |
| 402 | Assinatura da equipe ou direito de uso de recursos para a operação. |
| 403 | Participação na equipe, função, permissão do recurso e correspondência entre token e equipe. |
| 404 | Identificação do recurso, equipe ativa e rota. |
| 409 | Estado conflitante de recursos ou uma operação já em andamento. |
| 429 | Aguarde antes de tentar novamente e respeite Retry-After quando presente. |
| 5xx | Disponibilidade do serviço. Guarde o horário, a rota e a resposta sem dados sensíveis para investigar o problema. |
Operações bem-sucedidas retornam status 2xx. As exclusões CRUD geradas usam HTTP 200 com uma mensagem, enquanto as exclusões de objetos documentadas usam 204. Siga o contrato de cada endpoint, sem presumir um único status de sucesso para todos os métodos.
Paginação da lista
Listas CRUD geradas aceitam:
| Parâmetro | Padrão | Limite |
|---|---|---|
page | 1 | Use as informações de paginação devolvidas para solicitar mais páginas. |
per_page | 20 | No máximo 100. |
Os registros são retornados em data e metadados em pagination. Endpoints personalizados podem usar formatos de lista ou cursores diferentes; consulte seus parâmetros e contrato de resposta. Copie os IDs retornados para usar nas operações seguintes.
Novas tentativas e trabalho assíncrono
Repita leituras após uma falha transitória, com um intervalo limitado. Antes de repetir uma criação, implantação, acionamento de workflow, importação ou outra alteração de dados, inspecione o estado de destino para saber se a primeira tentativa já teve efeito. Esta referência pública não garante um contrato universal de chave de idempotência.
Uma requisição bem-sucedida de compilação, implantação, prévia ou comando pode iniciar trabalho que só termina depois. Consulte o status e os logs antes de considerar a ação concluída. Consulte verificação de implantação e logs e métricas.