Pular para o conteúdo principal

Erros

Todo erro da API v1 vem no mesmo envelope:

{
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "This token was not granted write access to this resource.",
"details": { "required": ["write", "all"], "granted": ["read"] }
}
}

Compare code, que é estável. A message é para gente e pode mudar. details aparece quando há o que detalhar.

Códigos​

StatuscodeQuando
400VALIDATION_ERRORcorpo, filtro, ordenação ou cursor inválidos
401INVALID_TOKEN, INVALID_AUDIENCE, INVALID_ISSUER, TOKEN_EXPIRED, TOKEN_REVOKEDproblema no access token (Autenticação)
403UNKNOWN_ORGANIZATIONa organização do token não está no Kadu
403INSUFFICIENT_SCOPEo token não tem o escopo da rota (Permissões)
403USER_PERMISSION_DENIED, NOT_A_MEMBERo papel da pessoa do token não permite
403FEATURE_NOT_ENABLEDa Kobana não liberou essa operação para a organização
403ENTITLEMENT_REQUIREDdisparo sem o Kadu no plano da organização
404NOT_FOUNDo recurso não existe, foi removido ou é de outra organização
409CONFLICTconflito de estado (por exemplo, nome de ambiente já usado)
409IDEMPOTENCY_KEY_REUSED, IDEMPOTENCY_REQUEST_IN_PROGRESSver Idempotência
413PAYLOAD_TOO_LARGEcorpo acima de 1 MiB
422MISSING_SECRETSdisparo com secrets exigidos sem valor no ambiente
422ENVIRONMENT_REQUIREDdisparo sem ambiente válido
422COST_LIMIT_REACHEDa organização atingiu o teto mensal de custo
429RATE_LIMITEDlimite de requisições (Limites)
500INTERNAL_ERRORfalha nossa. A mensagem nunca traz detalhes internos.
503AS_UNAVAILABLEa verificação do token está indisponível. Tente de novo depois do Retry-After.

Além desses, uma rota pode devolver um código próprio, documentado na referência dela.

O que fazer​

StatusRepetir?
4xxNão: a mesma requisição vai falhar de novo. Corrija a causa.
409 IDEMPOTENCY_REQUEST_IN_PROGRESSSim, depois de alguns segundos, com a mesma chave.
429Sim, depois do Retry-After.
5xxSim, com espera crescente e a mesma X-Idempotency-Key nas escritas.

O endpoint de disparo usa o mesmo envelope, com os códigos em minúsculas listados na página dele.