Follow these steps to generate a Postman collection from Prequel's OpenAPI 3.1 spec.
Prerequisites
-
Download and install Postman (v10 or later) if you do not already have the application.
-
Ensure you have network access to the below link, where you will find the public Prequel OpenAPI 3.1 spec:
https://docs.prequel.co/openapi/65f37500eadc81001e00ca00Note: The Prequel Open API spec is for the current version
2023-12-01. You can read more about the API version here: Versioning
1. Launch Postman and click Import
In the left-hand sidebar, click the Import button to open the import modal.
2. Paste the spec Link and configure import settings
- In the import modal, paste the Prequel spec URL:
https://docs.prequel.co/openapi/65f37500eadc81001e00ca00
- Once Choose how to import your API appears, select Postman Collection
- Then, select View Import Settings:
- Disable Enable optional parameters.
- Disable Include deprecated properties.
- Select Import.
3. Create an environment
Create an environment with the Environments tab (e.g., Prequel Dev) and set the following values:
| Key | Description |
|---|---|
| apiKey | The staging or production (based on the environment you're targeting) key beginning with sk_staging or sk_prod |
| baseUrl | The host from which you are making API requests. Depending on your Prequel environment, this may be: https://api.prequel.co, https://eu-api.prequel.co, or another host. |
Next Steps
- Run Requests - Expand the imported collection and send requests to verify connectivity.
- Customize & Save - Add examples, tests, or pre-request scripts as needed - your collection is now a living spec and testing playground.
Tip: You can re-run Import to receive the latest version of the API spec given periodic updates.