Lidando com erros ​

Algumas vezes enviar dados inválidos para a API pode resultar em erros. Neste documento você encontrará informações sobre como lidar com esses erros.

Toda requisição que não retornar um código de status 2xx ou 3xx será considerada uma requisição com erro.

O corpo da resposta conterá uma propriedade message com uma mensagem de erro amigável.

{
    "message": "Os dados fornecidos são inválidos."
}

Quando for um cadastro e o erro for de validação, o corpo da resposta conterá uma propriedade errors com os erros de validação.

{
    "message": "Os dados fornecidos são inválidos.",
    "errors": {
        "to_person_type": [
            "O campo tipo de pessoa de destino é obrigatório."
        ],
    }
}

Outras dicas ​

Informando o cabeçalho 'Friendly-Errors' com o valor 'true' você receberá mensagens de erro mais amigáveis.

Por padrão nossa API retorna os erros no formato, { campo: [mensagem de erro] }.

{
    "message": "Os dados fornecidos são inválidos.",
    "errors": {
        "to_person_type": [
            "O campo tipo de pessoa de destino é obrigatório."
        ],
    }
}

Informando o cabeçalho 'Friendly-Errors' você receberá uma propriedade adicional "error-messages" com todas mensagens de erro.

{
    "message": "Os dados fornecidos são inválidos.",
    "errors": {
        "to_person_type": [
            "O campo tipo de pessoa de destino é obrigatório."
        ],
    },
    "error-messages": [
        "O campo tipo de pessoa de destino é obrigatório."
    ]
}