Primeiros passos com a API Veolog
Conecte seu sistema à Veolog para calcular fretes e acompanhar envios.
A API Veolog permite calcular fretes operacionais ou de checkout e consultar os envios e o rastreamento da própria empresa. Está disponível para contas ativas com cadastro completo, seguindo as condições do plano, sem cobrança adicional de acesso à API.
Antes de começar
Confirme que a conta está ativa e conclua os dados e verificações solicitados pelo painel, incluindo celular e e-mail. Para cotar, mantenha também os dados do remetente completos em configurações do perfil. Veja os requisitos da conta.
O endereço das chamadas é https://veolog.com.br/api/v1/{alias}. O domínio deste portal de documentação não é o endereço da API.
Faça sua primeira consulta
Abra Credenciais de API no painel de desenvolvedores para obter o alias, a senha de API e o token. Proprietários e administradores podem gerenciar esse conjunto. Envie o token em User-Token e a senha de API em User-Secret-Key: os dois cabeçalhos são obrigatórios.
Configure VEOLOG_API_ALIAS, VEOLOG_API_TOKEN e VEOLOG_API_SECRET como variáveis de ambiente protegidas no seu servidor, com os valores do painel. O exemplo abaixo usa Bash, disponível no Linux, macOS, WSL ou Git Bash:
curl --request GET \
--url "https://veolog.com.br/api/v1/$VEOLOG_API_ALIAS/shipments?limit=20" \
--header "Accept: application/json" \
--header "User-Token: $VEOLOG_API_TOKEN" \
--header "User-Secret-Key: $VEOLOG_API_SECRET"Uma consulta válida retorna HTTP 200, com request_id, uma lista em data e informações em pagination. Por exemplo, uma conta sem envios visíveis retorna:
{
"request_id": "f875e9ea022597f7c9267fe13f5134a07",
"data": [],
"pagination": {
"next_cursor": null,
"has_more": false
}
}Uma lista vazia é uma resposta válida. Quando houver envios, use o id de um item de data para consultar seu detalhe e rastreamento. Veja envios e rastreamento para continuar pelas páginas.
Usar a coleção Postman
Importe a coleção Postman e configure estas variáveis no seu ambiente local:
| Variável | Valor |
|---|---|
base_url | https://veolog.com.br, sem /api/v1 e sem barra final |
alias | Alias exibido nas credenciais da conta |
user_token | Token da API da mesma conta |
user_secret_key | Senha de API da mesma conta |
shipment_id | ID obtido em Listar envios, necessário apenas para detalhe e rastreamento |
A coleção monta as URLs com {{base_url}}/api/v1/{{alias}}/… e já inclui os cabeçalhos de autenticação. Comece pela requisição Listar envios. Mantenha token e senha em valores locais protegidos; não os inclua ao compartilhar ou exportar a coleção.
O que você pode integrar
| Operação | Método e caminho |
|---|---|
| Calcular fretes | POST /api/v1/{alias}/quotes |
| Listar envios | GET /api/v1/{alias}/shipments |
| Consultar um envio | GET /api/v1/{alias}/shipments/{id} |
| Consultar rastreamento | GET /api/v1/{alias}/shipments/{id}/tracking |
Esta versão oferece cotações e consultas. Criação de envios, compra de etiquetas, pagamentos, cancelamentos e webhooks não fazem parte do contrato atual.
Convenções
- Todas as chamadas usam HTTPS e retornam JSON.
- Valores monetários são inteiros em centavos:
15000representa R$ 150,00. - Peso é informado em gramas e dimensões em centímetros.
- Datas incluem o fuso horário. Identificadores de envios e eventos são strings.
- O
request_idtambém aparece no cabeçalhoX-Request-ID.
As cotações usam a conta real e consomem o plano normalmente. Não há ambiente sandbox público.
Continue a integração
Updated about 1 month ago