Autenticação

Use o alias, a senha de API e o token da conta em todas as chamadas.

Cada requisição precisa do mesmo conjunto exibido em Credenciais de API no painel. Proprietários e administradores podem gerenciá-lo:

CredencialOnde enviar
AliasNo caminho /api/v1/{alias}/…
TokenCabeçalho User-Token
Senha de APICabeçalho User-Secret-Key

Os dois cabeçalhos são obrigatórios ao mesmo tempo. O alias sozinho não autoriza o acesso. Não é necessário obter um token temporário.

GET /api/v1/SEU_ALIAS/shipments?limit=20 HTTP/1.1
Host: veolog.com.br
Accept: application/json
User-Token: SEU_TOKEN_API
User-Secret-Key: SUA_SENHA_API

SUA_SENHA_API é a senha mostrada nas credenciais de API, não a senha de login do painel.

Prepare a conta

A conta precisa estar ativa e com o cadastro completo. No cadastro inicial, conclua as pendências indicadas pelo painel:

  • Dados do titular, incluindo nome, CPF e endereço completo.
  • Dados empresariais, quando a opção de empresa estiver habilitada.
  • Validação do celular e do e-mail de login.

Você também pode revisar os dados em Configurações do perfil. Os links do painel exigem login; as chamadas à API usam somente as credenciais dos cabeçalhos.

403 account_not_eligible impede o acesso à API enquanto a conta estiver inativa ou o cadastro estiver incompleto. Já 422 sender_profile_required ocorre na cotação: revise os dados do remetente nas mesmas configurações do perfil. O CEP enviado em origin_zipcode não substitui esse cadastro. Se a conta estiver inativa, procure o suporte.

Uma conta por conjunto

Alias, token e senha devem pertencer à mesma empresa. Parceiros que atendem várias empresas usam as credenciais correspondentes a cada uma. O login no painel e seus cookies não substituem a autenticação da API.

Proteja e atualize as credenciais

Faça as chamadas a partir do backend. Guarde os segredos em variáveis protegidas ou em um gerenciador de segredos. Não os inclua em JavaScript público, aplicativos distribuídos, repositórios ou logs.

A rotação troca a senha de API e o token, preservando o alias. Atualize todos os sistemas que usam esse conjunto. Após rotação ou revogação, as credenciais anteriores deixam de autenticar chamadas à API pública.

Falhas de autenticação

  • 401 invalid_credentials: uma credencial está ausente, incorreta, revogada ou pertence a outro conjunto.
  • 403 account_not_eligible: a conta está inativa ou com cadastro incompleto.
  • 503 authentication_unavailable: a autenticação está temporariamente indisponível. Não gere novas credenciais automaticamente.

Consulte os exemplos e o tratamento de novas tentativas em Erros e limites. Ao solicitar suporte, informe o request_id e o horário da chamada. Não envie senha ou token.


Did this page help you?