FleetPay / Developers

Sua Operação. Conectada.

Cadastros, repasses e documentos fiscais. Integre os fluxos da FleetPay ao software que sua operação já usa.

01 / OpenAPI 3.1

Comece em Homologação

Cada ambiente tem sua própria credencial. Crie a sua em Configurações → API de Integração e habilite os escopos necessários.

Homologaçãohttps://api.fleetpay.site/v1

Produçãohttps://api.fleetpay.tech/v1

Verifique o Acesso Fiscal

Exemplo de consulta, sem emissão ou pagamento. Requer o escopo fiscal habilitado.

curl https://api.fleetpay.site/v1/fiscal/status \
  --header "Authorization: Bearer $FLEETPAY_API_KEY" \
  --header "Accept: application/json"

Interprete a Resposta

Resposta fictícia para estudo local, validada contra StatusEnvelope. Não foi obtida de uma conta real: o documento com zeros não é um CNPJ válido e não deve ser enviado à API. Este exemplo não comprova habilitação do seu ambiente.

Ver JSON de Exemplo

{
  "data": {
    "company": {
      "document": "00000000000000",
      "name": "Fictional Company / Exemplo Fictício"
    },
    "environment": "homologacao",
    "certificate": {
      "configured": false,
      "valid_until": null
    },
    "documents": {
      "nfe": false,
      "cte": false,
      "ciot": false,
      "mdfe": false
    }
  },
  "environment": "homologacao"
}

Confira environment antes de prosseguir: esta consulta usa homologacao. certificate.configured e documents informam o estado retornado pela API; não significam que um documento foi emitido ou um pagamento foi realizado. Uma resposta HTTP 200 não substitui a verificação desses campos.

401: confira a credencial e o ambiente; não repita indefinidamente.
403: confira os escopos e a habilitação da operação antes de tentar novamente.
429: reduza a frequência. Respeite Retry-After quando presente; sem esse cabeçalho, use tentativas limitadas com espera progressiva. Não reproduza automaticamente esse comportamento em operações de emissão ou pagamento.

Consultar o Contrato da Resposta ↗

Guarde as credenciais no servidor. Nunca inclua chaves no código do navegador.

02 / Acesso

Permissões Explícitas

Toda credencial começa sem acesso. Os escopos habilitados no painel determinam quais operações ela pode executar.

`fiscal`

Documentos e configuração fiscal. Exclusivo de transportadoras.

`operacao`

Liberação e pagamento de parcelas de repasse. Operações que movimentam dinheiro.

`cadastros`

Convites, consulta de agregados e conferência de chave Pix.

`consultas`

Consultas de RNTRC.

API Key ou OAuth2

As duas formas usam Authorization: Bearer. Chaves estáticas começam com fp_hml_ ou fp_prd_, conforme o ambiente. OAuth2 usa client_credentials em POST /oauth/token, fora de /v1. O token expira em uma hora; emita outro ao expirar.

Respostas de Autorização

Credenciais usadas no ambiente incorreto recebem 401. Uma operação fora dos escopos habilitados recebe 403 com error.code: escopo_nao_habilitado.

Simulação e Efeito Regulatório

O contrato atual identifica operações de CIOT e consultas ANTT simuladas em homologação, sem efeito regulatório. Em produção, essas operações recusam a execução enquanto o provedor correspondente estiver indisponível. CT-e e MDF-e usam integração fiscal de homologação; confira o campo environment antes de tratar uma emissão como definitiva.

03 / MCP

O Próximo Caminho de Integração

Conheça as consultas MCP implementadas e seus limites. A integração externa depende de avaliação, habilitação e validação em homologação.

Explorar o MCP ↗