Postman collection

Every build of these docs generates a Postman collection from the invoicing API’s OpenAPI document, with Postman’s open-source converter, so it always matches the API reference.

Download	What it is
flashpi.postman_collection.json	The Postman collection (format v2.1): one folder per area, one request per operation.
openapi.json	The OpenAPI 3.1 document itself, for other tools: Insomnia, Bruno, Hoppscotch or a client generator.

Import it

1. Get the collection. Download it, or copy its link: https://flashpi.com.ec/docs/postman/flashpi.postman_collection.json.

2. Import it. In Postman, choose Import and drop the file or paste the link. The collection is called Flashpi Invoicing API.

3. Set your API key. Open the collection’s Variables and set apiKey to a test key (fp_test_...) from the console’s API keys, with access to every issuer and read and write access. See Authentication and API keys.

4. Set the issuer and your email. Set issuerId to the demo issuer’s ID, which the console’s Overview shows, or to one of your own issuers, and buyerEmail to your own address. See Sandbox and demo issuer.

5. Send a request. Send Status → Service status to check the connection, then Invoices → Issue an invoice.

What the collection sets up

Variable or header	Value
baseUrl	https://api.flashpi.com.ec. Test and live keys use the same host.
apiKey	Empty. Every request sends it as Authorization: Bearer {{apiKey}}, except GET /v1/status, which is public.
issuerId	Empty. The issuer in the bodies of the document requests, and in the path of the issuer requests.
buyerEmail	Empty. Every email address in the request bodies, so the email with the RIDE and the XML of a document you issue reaches you, not the examples’ fictional buyers.
establishmentId, emissionPointId, certificateId, documentId, endpointId, deliveryId, eventId	Empty, one per path parameter. Copy each ID from an earlier answer.
Idempotency-Key	{{$guid}}: a new key on every send, so each send is a new request. To retry one request safely, put a fixed value instead. See Idempotency.

• The request bodies are the examples of the OpenAPI document, the same as in the API reference, with {{issuerId}} and {{buyerEmail}} in place of the examples’ issuer and email addresses. Before you issue a document, set issueDate to today or remove it (it defaults to today in Ecuador). For a waybill, move transportStartDate and transportEndDate to that day or later too: the transport cannot start before the issue date.
• Optional query parameters are in each request but turned off. Turn on the ones you need.
• The collection has no saved responses: the API reference shows every answer and Errors every error code.

Caution

An exported or shared collection carries its variables. Remove your API key before you share one, and use test keys in Postman, never live keys.

Updates

The collection and openapi.json change whenever the API changes. Import the collection again to get the new version. Operations that are only planned, such as batches and queries by access key, are not in either file.