API da Frota Simples
Integre a sua Conta ao ERP, ao TMS ou à planilha da operação: leia e escreva dados por uma API REST e receba eventos por webhook.
O que a API faz
- Dá acesso, servidor a servidor, aos dados da sua Conta — a chave já identifica a Conta, então nenhuma rota pede o id dela.
- Responde em JSON, com campos em camelCase, valores em centavos e datas em ISO 8601 com fuso.
- Avisa o seu sistema quando algo muda, por webhook assinado, ou por consulta à lista de eventos.
- Tudo o que existe está na referência, gerada do próprio código. O que não está lá ainda não existe — por exemplo, a emissão de documentos fiscais pela API ainda não está disponível.
Quem tem acesso
A API faz parte dos planos Profissional (R$ 297/mês) e Enterprise (sob consulta). Quem cria as chaves é o Proprietário da Conta, em Configurações → Integrações.
Não existe ambiente de testes separado. Para experimentar sem mexer na operação, use uma Conta só para testes.
Comece em 5 minutos
- Entre na plataforma como Proprietário da Conta e abra Configurações → Integrações.
- Crie uma chave. Ela aparece uma única vez — guarde no cofre de segredos do seu sistema.
- Faça a primeira chamada:
Terminal
export FROTASIMPLES_CHAVE=fs_live_...
curl https://frotasimples.com/api/v1/conta \
-H "Authorization: Bearer $FROTASIMPLES_CHAVE"A resposta traz a Conta, o plano e os escopos da chave. Daí em diante, siga o guia Comece em 5 minutos.
Guias
- Comece em 5 minutos — Crie a chave e faça a primeira chamada.
- Autenticação — A chave de API, o cabeçalho e o que fazer se ela vazar.
- Escopos — O que cada chave pode ler e escrever.
- Paginação — Listas por cursor, sem pular nem repetir linha.
- Erros — O formato problem+json e cada código de erro.
- Idempotência — Repetir uma escrita sem criar duas vezes.
- Limites de requisição — Quantas chamadas por minuto cada plano permite.
- Webhooks — Receber eventos e verificar a assinatura.
- Versionamento — Como a API muda sem quebrar a sua integração.
- Histórico de mudanças — O que mudou em cada versão.
Arquivos
- Documento OpenAPI 3.1 — importe no Postman, no Insomnia ou num gerador de cliente.
- Coleção de exemplos curl — uma chamada de exemplo por operação.