FleetPay / Developers

Tu Operación. Conectada.

Registros, liquidaciones y documentos fiscales. Conecta los flujos de FleetPay al software que tu operación ya utiliza.

01 / OpenAPI 3.1

Empieza en Pruebas

Cada entorno tiene sus propias credenciales. Crea las tuyas en Configuración → Integración API y habilita los permisos necesarios.

Pruebashttps://api.fleetpay.site/v1

Producciónhttps://api.fleetpay.tech/v1

Verifica el Acceso Fiscal

Ejemplo de consulta, sin emisión ni pago. Requiere el permiso fiscal.

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

Interpreta la Respuesta

Respuesta ficticia para estudio local, validada contra StatusEnvelope. No proviene de una cuenta real: el documento con ceros no es un CNPJ válido y no debe enviarse a la API. Este ejemplo no demuestra la habilitación de tu entorno.

Ver JSON de Ejemplo

{
  "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"
}

Comprueba environment antes de continuar: esta consulta usa homologacao. certificate.configured y documents describen el estado devuelto por la API; no significan que se emitió un documento o se realizó un pago. HTTP 200 no sustituye la revisión de estos campos.

401: comprueba la credencial y el entorno; no repitas indefinidamente.
403: comprueba los permisos y la habilitación antes de reintentar.
429: reduce la frecuencia. Respeta Retry-After cuando esté presente; si falta, usa reintentos limitados con espera progresiva. No apliques automáticamente este comportamiento a emisiones o pagos.

Consultar el Contrato de Respuesta ↗

Guarda las credenciales en el servidor. Nunca incluyas claves en el código del navegador.

02 / Acceso

Permisos Explícitos

Cada credencial empieza sin acceso. Los permisos habilitados en el panel determinan qué operaciones puede ejecutar.

`fiscal`

Documentos y configuración fiscal. Exclusivo para transportistas.

`operacao`

Liberación y pago de cuotas de liquidación. Estas operaciones mueven dinero.

`cadastros`

Invitaciones, consulta de conductores asociados y verificación de claves Pix.

`consultas`

Consultas del registro RNTRC.

API Key u OAuth2

Ambos métodos usan Authorization: Bearer. Las claves estáticas comienzan con fp_hml_ o fp_prd_, según el entorno. OAuth2 usa client_credentials en POST /oauth/token, fuera de /v1. El token expira después de una hora; solicita uno nuevo al expirar.

Respuestas de Autorización

Las credenciales usadas en el entorno incorrecto reciben 401. Las operaciones fuera de los permisos habilitados reciben 403 con error.code: escopo_nao_habilitado.

Simulación y Efecto Regulatorio

El contrato actual identifica operaciones CIOT y consultas ANTT simuladas en pruebas, sin efecto regulatorio. En producción, estas operaciones rechazan la ejecución mientras el proveedor correspondiente no esté disponible. CT-e y MDF-e usan una integración fiscal de pruebas; verifica el campo environment antes de tratar una emisión como definitiva.

03 / MCP

El Próximo Camino de Integración

Conoce las consultas MCP implementadas y sus límites. La integración externa requiere evaluación, habilitación y validación en pruebas.

Explorar MCP ↗