Appearance
Autenticação
Todas as chamadas à API de integração usam uma API Key no header Authorization:
Authorization: Bearer <api_key>A API Key é criada pelo painel do ViaPost (Configurações → API Keys) — o token completo (keyid.secret) só é exibido uma única vez, no momento da criação. Guarde-o com segurança; não é possível recuperá-lo depois.
Scopes
Cada API Key tem uma ou mais permissões (scopes) associadas:
| Scope | Permite |
|---|---|
email:send | Enviar e-mail via POST /v1/send |
domains:read | Ler domínios e registros DNS |
POST /v1/send exige explicitamente o scope email:send — sem ele, a chamada retorna 403 Forbidden. As demais rotas (domínios, mensagens, inbound, webhooks) hoje só validam se a chave pertence a um tenant ativo, sem checagem de scope adicional.
Erros de autenticação
| Situação | Status | Código |
|---|---|---|
Header Authorization ausente ou malformado | 401 | unauthorized |
| API Key inválida, revogada ou expirada | 401 | unauthorized |
| Tenant da chave suspenso/inativo | 403 | forbidden |
| Chave sem o scope exigido pela rota | 403 | forbidden |
Veja o formato completo de erro em Erros.