Appearance
Erros
Erros são retornados com o status HTTP apropriado e um corpo JSON no formato:
json
{
"error": {
"code": "validation_error",
"message": "descrição legível do erro",
"request_id": "abc123"
}
}request_id identifica a requisição nos logs do ViaPost — inclua-o ao reportar um problema para o suporte.
Códigos possíveis
| Status | code | Quando ocorre |
|---|---|---|
400 | validation_error | Corpo da requisição inválido, campo obrigatório ausente, campo desconhecido, regra de negócio violada (ex.: domínio remetente não verificado) |
401 | unauthorized | API Key ausente, malformada, inválida, revogada ou expirada |
403 | forbidden | Tenant inativo/suspenso, ou chave sem o scope exigido |
404 | not_found | Recurso não existe ou não pertence ao tenant da chave |
409 | conflict | Idempotency-Key repetida para uma requisição diferente |
429 | rate_limited | Limite de requisições por segundo excedido |
500 | internal_error | Erro interno inesperado |