Tratamento de erros

Formato

Os erros de validação, autenticação, limite e tempo devolvem um JSON com statusCode, error, code e message. Use o code para decidir o que fazer; o message é texto para pessoas e pode mudar. 404 e 500 trazem só statusCode e message.

{
  "statusCode": 400,
  "error": "Bad Request",
  "code": "VALIDATION_ERROR",
  "message": [
    "initialDate deve estar no formato YYYY-MM-DD"
  ]
}

Em VALIDATION_ERROR o message é uma lista com um item por problema encontrado.

Status e códigos

Status	code	Quando
400	VALIDATION_ERROR	Parâmetro inválido ou desconhecido: data fora de YYYY-MM-DD, id não inteiro, tabulationCategoryId que não é UUID, limit fora de 1 a 200, page fora de 1 a 10000, ticketStatus fora da lista, search com mais de 100 caracteres
400	INVALID_PERIOD	initialDate depois de finalDate
400	PERIOD_TOO_LONG	Período acima de 31 dias no detalhado ou 366 nos demais
401	API_KEY_MISSING	Nenhum header de chave
401	API_KEY_INVALID	Chave inexistente, desativada ou excluída
401	API_KEY_EXPIRED	Chave expirada
403	ENTITLEMENT_PUBLIC_API_DISABLED	Plano sem API Pública
403	SUBSCRIPTION_EXPIRED	Assinatura da empresa vencida
403	COMPANY_DISABLED	Empresa desativada
404	(sem code)	Rota inexistente
408	REQUEST_TIMEOUT	Requisição acima de 30 segundos
429	RATE_LIMIT_EXCEEDED	Mais de 120 requisições por minuto na chave
429	TOO_MANY_AUTH_FAILURES	Muitas tentativas com chave inválida vindas do mesmo IP
500	(sem code)	Falha inesperada; tente de novo e, se persistir, fale com o suporte

Exemplos

{
  "statusCode": 401,
  "error": "Unauthorized",
  "code": "API_KEY_INVALID",
  "message": "Chave de API inválida ou desativada."
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "code": "ENTITLEMENT_PUBLIC_API_DISABLED",
  "message": "A API Pública não está incluída no plano da empresa."
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "code": "PERIOD_TOO_LONG",
  "message": "O período máximo deste relatório é de 31 dias."
}