Chaves de API & Autenticação

​

Como Gerar sua Chave de API

1. Acesse o Painel do BulkRoute como Administrador.
2. Navegue até Parceiros > Minha Empresa (/admin/my-tenant) → aba Chaves de API.
3. Clique em Gerar Nova Chave.
4. Dê um nome de identificação (ex: Integração Bling Produção).
5. Copie o valor gerado (iniciado pelo prefixo bk_live_...).

​

Como Autenticar as Requisições

curl -X GET "https://api.bulkroute.com.br/api/carriers" \
  -H "X-API-Key: bk_live_1234567890abcdef" \
  -H "Content-Type: application/json"

​

Múltiplas Chaves

​

Por que múltiplas chaves?

• Isolamento: se uma chave for comprometida, você revoga só ela sem afetar as outras
• Auditoria: o log de requisições mostra qual chave fez cada chamada
• Rate limiting: cada chave tem seu próprio limite de 100 req/min

​

Revogar uma Chave

1. Acesse Parceiros > Minha Empresa (/admin/my-tenant) → aba Chaves de API
2. Localize a chave desejada
3. Clique em Revogar
4. Confirme

​

Rotacionamento de Chaves

1. Gere uma nova chave
2. Atualize seus sistemas com a nova chave
3. Verifique se tudo funciona
4. Revogue a chave antiga

​

Segurança

​

Boas práticas

• ✅ Armazene a chave em variável de ambiente (BULKROUTE_API_KEY)
• ✅ Use gerenciador de segredos (AWS Secrets Manager, Vault, Doppler)
• ✅ Restrinja acesso à chave apenas aos sistemas que precisam
• ✅ Rotacione a cada 90 dias
• ✅ Use chaves separadas para cada ambiente (prod/staging)

​

O que NÃO fazer

• ❌ Não commite a chave no repositório git
• ❌ Não hardcode a chave no frontend (JavaScript público)
• ❌ Não compartilhe a chave em chats/e-mails
• ❌ Não use a mesma chave para todos os sistemas
• ❌ Não deixe chaves antigas ativas sem uso

​

Identificação do Tenant

​

Exemplos por linguagem

​

Node.js

const response = await fetch('https://api.bulkroute.com.br/api/shipments', {
  headers: {
    'X-API-Key': process.env.BULKROUTE_API_KEY,
    'Content-Type': 'application/json',
  },
});

​

Python

import requests

headers = {
    'X-API-Key': os.environ['BULKROUTE_API_KEY'],
    'Content-Type': 'application/json',
}
response = requests.get('https://api.bulkroute.com.br/api/shipments', headers=headers)

​

PHP

$ch = curl_init('https://api.bulkroute.com.br/api/shipments');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: ' . getenv('BULKROUTE_API_KEY'),
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

​

Próximos passos

• Introdução à API — ambientes, rate limit, paginação
• Webhooks — receba eventos push em tempo real
• Catálogo OpenAPI — explore todos os endpoints