Na nossa API, utilizamos códigos de resposta HTTP para indicar o resultado de uma solicitação. A seguir, apresentamos uma tabela que resume os códigos mais comuns que você encontrará, suas significações e exemplos de situações em que podem ser retornados.
Códigos de Sucesso (2xx)
| Código | Descrição | Exemplo de Uso |
|---|---|---|
| 200 | OK | A solicitação foi bem-sucedida. |
| 201 | Created | Um novo recurso foi criado com sucesso. |
| 204 | No Content | A solicitação foi bem-sucedida, mas não há conteúdo a retornar. |
Códigos de Erro do Cliente (4xx)
| Código | Descrição | Exemplo de Uso |
|---|---|---|
| 400 | Bad Request | Um parâmetro obrigatório foi omitido. |
| 401 | Unauthorized | A autenticação falhou ou não foi fornecida. |
| 403 | Forbidden | O usuário não tem permissão para acessar o recurso. |
| 404 | Not Found | O recurso solicitado não foi encontrado. |
| 422 | Unprocessable Entity | A solicitação está bem formada, mas não pode ser processada (ex: dados inválidos). |
Códigos de Erro do Servidor (5xx)
| Código | Descrição | Exemplo de Uso |
|---|---|---|
| 500 | Internal Server Error | Ocorreu um erro inesperado no servidor. |
| 502 | Bad Gateway | O servidor agindo como um gateway recebeu uma resposta inválida. |
| 503 | Service Unavailable | O serviço está temporariamente indisponível. |
Observações Importantes:
- Respostas Detalhadas: Sempre que possível, a API retornará uma mensagem de erro detalhada no corpo da resposta, indicando a causa do problema.
- Verificação de Status do Servidor: Em caso de erro 5xx, recomenda-se verificar a página de status dos servidores da Bspay para mais informações.
Exemplo de retorno:
{
"statusCode": 401,
"message": "Credenciais Invalidas"
}