Ir al contenido
FlashpiFlashpiFlashpi Docs

Colección de Postman

Cada build de esta documentación genera una colección de Postman a partir del documento OpenAPI de la API de facturación, con el convertidor de código abierto de Postman, así que siempre coincide con la referencia de la API.

Descarga Qué es
flashpi.postman_collection.json La colección de Postman (formato v2.1): una carpeta por área y una solicitud por operación.
openapi.json El documento OpenAPI 3.1, para otras herramientas: Insomnia, Bruno, Hoppscotch o un generador de clientes.

Impórtala

Sección titulada «Impórtala»

  1. Obtén la colección. Descárgala, o copia su enlace: https://flashpi.com.ec/docs/postman/flashpi.postman_collection.json.

  2. Impórtala. En Postman, elige Import y suelta el archivo o pega el enlace. La colección se llama Flashpi Invoicing API.

  3. Configura tu API key. Abre las Variables de la colección y pon en apiKey una API key de prueba (fp_test_...) de la sección API keys de la consola, con acceso a todos los emisores y de lectura y escritura. Mira Autenticación y API keys.

  4. Configura el emisor y tu correo. Pon en issuerId el ID del emisor demo, que muestra el Resumen de la consola, o el de uno de tus emisores, y en buyerEmail tu propia dirección. Mira Sandbox y emisor demo.

  5. Envía una solicitud. Envía Status → Service status para comprobar la conexión, y luego Invoices → Issue an invoice.

Qué configura la colección

Sección titulada «Qué configura la colección»
Variable o encabezado Valor
baseUrl https://api.flashpi.com.ec. Las API keys de prueba y de producción usan el mismo host.
apiKey Vacía. Cada solicitud la envía como Authorization: Bearer {{apiKey}}, excepto GET /v1/status, que es pública.
issuerId Vacía. El emisor en el cuerpo de las solicitudes de comprobantes, y en la ruta de las solicitudes de emisores.
buyerEmail Vacía. Cada dirección de correo de los cuerpos de las solicitudes, así el correo con el RIDE y el XML de un comprobante que emitas te llega a ti, y no a los compradores ficticios de los ejemplos.
establishmentId, emissionPointId, certificateId, documentId, endpointId, deliveryId, eventId Vacías, una por parámetro de ruta. Copia cada ID de una respuesta anterior.
Idempotency-Key {{$guid}}: una clave nueva en cada envío, así que cada envío es una solicitud nueva. Para reintentar una solicitud sin riesgo, pon un valor fijo. Mira Idempotencia.
  • Los cuerpos de las solicitudes son los ejemplos del documento OpenAPI, los mismos de la referencia de la API, con {{issuerId}} y {{buyerEmail}} en lugar del emisor y de las direcciones de correo de los ejemplos. Antes de emitir un comprobante, pon la fecha de hoy en issueDate o quítalo (por defecto es hoy en Ecuador). En una guía de remisión, mueve también transportStartDate y transportEndDate a ese día o después: el transporte no puede empezar antes de la fecha de emisión.
  • Los parámetros de consulta opcionales están en cada solicitud, pero desactivados. Activa los que necesites.
  • La colección no tiene respuestas guardadas: la referencia de la API muestra cada respuesta y Errores cada código de error.

Actualizaciones

Sección titulada «Actualizaciones»

La colección y openapi.json cambian cada vez que cambia la API. Vuelve a importar la colección para obtener la versión nueva. Las operaciones que solo están planificadas, como los lotes y las consultas por clave de acceso, no están en ninguno de los dos archivos.