What are API collections
An API collection in Postman is a set of pre-configured API requests that make it convenient to test API methods. They help developers integrate with APIs faster and more efficiently by eliminating the need to manually create requests.
How API collections for Nova Post are organized
- Sandbox for testing
Test APIs in a secure environment before full integration. The collection is specifically designed for the sandbox environment, allowing clients to test APIs without affecting production data.
URL for the sandbox environment: https://api-stage.novapost.com/v.1.0/
Separate API keys are required for the sandbox environment. Follow the provided instructions to obtain them
- Pre-configured requests
The collection includes ready-to-use methods for key operations:
- 1Authorization: Generate JWT tokens for API access.
- 2Directory operations: Lists of cities, branches, and shipment types.
- 3Shipment operations: Create, edit, and track shipments.
- 4Label printing: Generate thermal labels for parcels.
- Automated authentication
The collection automatically saves the generated JWT token into Postman variables, simplifying the execution of sequential requests.
- Integrated documentation
Each method in the collection is accompanied by built-in descriptions, usage examples, and explanations. This helps developers quickly understand API functionality.
Example of documentation display:
Restrictions: the collection is designed exclusively for the sandbox environment.
To operate in the production environment, you must adapt the URLs and variables according to the API documentation.
How to get started with the collection
- 1
- 2Import the downloaded collection to your Postman workspace:
- 3Configure the apiKey Variable with your test API key obtained from Nova Post.
Done! Use the pre-configured requests to test the functionality of the API.