Padrão de Erros & Tratamento de Erros

1. Visão Geral

A nossa API utiliza códigos de resposta HTTP convencionais para indicar o sucesso ou a falha de uma requisição.

2xx (Sucesso): Sua solicitação foi recebida, compreendida e processada com êxito.
4xx (Erro do Cliente): Houve um problema com a requisição (ex: parâmetros inválidos ou falta de autenticação).
5xx (Erro do Servidor): Ocorreu uma falha inesperada em nossos servidores."

Para que seja possível manter a integração com qualidade e fazer o melhor uso das funcionalidades oferecidas, é importante entender os possíveis erro e garantir que as validações sejam feitas antes do envio

🚧
Variações de Erros
Em nossos endpoints os erros podem se diferenciar de acordo com cada necessidade por isso recomendamos que navegue nas páginas de erros e confira os possíveis retornos.

2. Principais Códigos de Retorno

Código	Status	Descrição
`200` ou `201`	OK	Sua solicitação foi concluída com sucesso, seja consulta (GET) ou envio (POST) de informação.
`400`	Bad Request	Indica que a solicitação não pôde ser concluída ou contém alguma informação incorreta/inválida. Verifique o detalhamento do erro no retorno
`401`	Invalid Token	Token de acesso utilizado está inválido ou expirado.
`403`	Forbidden	Você autenticou, mas não tem permissão para acessar o recurso.
`404`	Not found	Rota não foi encontrada ou existe alguma informação incorreta.
`500`	Internal Server Error	Ocorreu um erro interno na aplicação

3. Entendimento do Erro — Informações da resposta

Mantemos um modelo de retorno em que buscamos fornecer informações para que seja possível entender o detalhe do erro de acordo com cada endpoint e suas especificidades. Veja abaixo os campos retornados:

Campo	Descrição
`code`	O código de status HTTP de erro retornado. Pode ser: `2xx`, `4xx` ou `5xx`
`key`	Para erros de objeto de API, uma string curta da lista do lado direito, descrevendo o tipo de erro que ocorreu.
`message`	Uma mensagem legível que fornece uma breve descrição do erro.
`details`	Uma mensagem legível que fornece mais detalhes sobre o erro.

4. Exemplo de Response

{
    "code": "REQUEST_VALIDATION_ERROR",
    "message": "Some fields are not valid",
    "details": [
        {
            "target": "field",
            "message": "error description"
        }
    ]
}