A API utiliza os seguintes códigos HTTP para indicar que uma requisição terminou com sucesso.
| 200 | Indicação de que o processo foi performado corretamente, e o retorno poderá ser verificado no corpo da resposta HTTP. | GET, POST, PUT e DELETE |
| 204 | Indicação de que o recurso foi editado ou removido com sucesso. | POST, PUT e DELETE |
A API utiliza os seguintes códigos HTTP para indicar alguns erros:
| 422 | Exceções de negócios |
| 400 | Requisição malformada |
| 401 | Requisição precisa de autenticação |
| 403 | Requisição Negada |
| 404 | Recurso não encontrado |
| 405 | Método não permitido |
| 429 | Requisição excedeu a quantidade máxima permitida para a API |
| 500 | Erro no Servidor |
Os erros mencionados acima serão acompanhados pelo seguinte padrão:
{
"Errors": [
"string"
],
"StatusCode": "string"
}
{
"errors": [
{
"code": "string",
"type": "string",
"message": "string",
"objectId": "string"
}
]
}
Headers
A API usa os seguintes parâmetros de cabeçalho quando configurada com limitação de taxa:
| X-Rate-Limit-Limit: |
Número de solicitações permitidas no período atual (Quantas chamadas o cliente tem configurada nessa API Ex: 125 requests per Hour) |
| X-Rate-Limit-Remaining: |
Número de chamadas restantes no período atual (Quantas chamadas restantes ainda possui Ex: 121) |
| X-Rate-Limit- Reset: |
Número de segundos restantes no período atual (Tempo em segundos até que seja reiniciado, ou seja, voltar a configuração inicial de 125 por hora Ex: 3579) |