FreteFlow / docs

API pública — Visão geral

Integre seus sistemas ao FreteFlow via REST.

Base URL

text
https://freteflow.fr.com.br/api/public/v1

Autenticação

Toda chamada exige uma API key no header X-API-Key. Gere a sua em Integrações → API Keys.

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

Trate sua API key como senha

Nunca exponha a key em código cliente, repositório público ou logs. Se ela vazar, revogue imediatamente em Integrações.

Formato de erros

json
{
  "error": {
    "code": "freight_not_found",
    "message": "Frete não encontrado",
    "status": 404
  }
}

Rate limits

Por padrão, 60 requisições por minuto por API key. O header X-RateLimit-Remaining indica o quanto resta na janela atual.

Endpoints e referências