Status de retornos
A tabela abaixo especifica os status code que podem retornar após uma requisição na API:
Código de retorno | Mensagem (message) | Descrição / comentário |
---|---|---|
200 | OK | A requisição foi bem sucedida. |
201 | Created | A requisição foi bem sucedida e um novo recurso foi criado. |
202 | Accepted | Usado para tarefas assíncronas. A solicitação foi aceita para o processamento, mas o resultado real deve ser obtido de outra chamada de API. |
204 | No Content | A requisição foi bem sucedida, mas não tem nada para retornar. Geralmente é utilizada como resposta para requisições DELETE. |
400 | Bad Request | A requisição é inválida. A causa do erro vai descrita no corpo do retorno. |
401 | Unauthorized | Autenticação falhou. |
402 | Payment Required | A conta vinculada ao token do usuário está com a validade expirada. Entre em contato com os administradores da conta. |
403 | Forbidden | O usuário não tem acesso ao recurso. Verifique o nível do usuário (Consultor ou Gestor). |
404 | Not Found | O usuário está fazendo uma requisição para algo que não existe. |
422 | Unprocessable Entity | O usuário tem um problema com os dados enviados. |
429 | Too Many Requests | O usuário enviou muitas requisições. A API aceita 120 requisições a cada 30 segundos. |
500 | Internal Server Error | Algo deu errado em nossa infraestrutura. |
503 | Temporarily unavailable | Essa resposta geralmente é retornada quando o sistema está em manutenção. |
524 | A Timeout Occurred | Essa resposta é retornada quando a requisição excede o tempo limite. Por padrão, o gateway da API cancela as requisições que tem duração acima de 60 segundos. Para resolver, uma boa prática é utilizar o parâmetro query de paginação na requisição, insendo um ?show=000&page=000 ao final da URL. |
Updated about 1 year ago