A Osigu utiliza códigos de resposta HTTP convencionais para indicar o sucesso ou a falha de uma solicitação às nossas APIs.
De modo geral:
- Códigos na faixa 2xx indicam sucesso.
- Códigos na faixa 4xx sinalizam um erro na solicitação, geralmente devido a um parâmetro incorreto ou ausente.
- Códigos na faixa 5xx indicam um erro nos servidores da Osigu.
Na maioria dos casos, a API da Osigu responderá com um objeto de erro JSON para códigos na faixa 4xx, fornecendo detalhes sobre o problema.
{
"code": "unprocessable_entity",
"message": "Um ou mais dos parâmetros fornecidos são inválidos",
"errors":[
{
"path":"authorization.items.id",
"message":"O campo id é obrigatório"
}
]
}
{
"code": "authorization_voided",
"message": "A autorização foi anulada",
"errors": null
}