Webservice V2
Erros e códigos de status

Erros e códigos de status

A API usa códigos de status HTTP convencionais. Erros de negócio trazem um campo message; erros de validação trazem também errors, com a lista de problemas por campo.

Erro de validação (422)

Quando algum campo do corpo é inválido, a resposta é 422 no formato padrão:

json
{
  "message": "The given data was invalid.",
  "errors": {
    "variation_id": ["The selected variation id is invalid."]
  }
}

Erro de negócio

Regras de negócio (produto não autorizado, saldo insuficiente, etc.) retornam um message explicando o motivo:

json
{
  "message": "Saldo insuficiente."
}

Códigos mais comuns

CódigoSignificado
200OK — requisição bem-sucedida.
201Created — ativação criada com sucesso.
401Unauthorized — token ausente, inválido ou expirado.
403Forbidden — sem permissão (ex.: produto não autorizado para a agência).
422Unprocessable — dados inválidos (veja errors) ou regra de negócio.
5xxErro no servidor.
Recebeu 401?
Refaça o login para obter um novo token. Veja o guia de Autenticação.