API: autenticação

API keys, escopos e rotação.

Gerando uma API key

  1. 1

    Acesse Integrações → API Keys

  2. 2

    Clique em Nova API key, dê um nome descritivo (ex: 'ERP produção')

  3. 3

    Selecione os escopos (read, write, admin)

  4. 4

    Copie a key — ela é exibida apenas uma vez

Uso

Envie no header X-API-Key em toda requisição:

bash
curl https://freteflow.fr.com.br/api/public/v1/freights \
  -H "X-API-Key: ff_live_abc123..."

Escopos

  • read — leitura de fretes, ofertas, motoristas.
  • write — criação e atualização de fretes/ofertas.
  • admin — gerenciamento de usuários e configurações.

IP allowlist (opcional)

Para keys de produção, restrinja os IPs que podem usá-la em Editar API key → IPs permitidos.

Rotação

Crie uma nova key, atualize seus serviços, e só então revogue a antiga. Mantenha registro de qual sistema usa qual key.

Vazamento

Se suspeitar de vazamento, revogue imediatamente. Logs de uso ficam em Integrações → API Keys → Detalhes.