Get started
API setup
Postman

Proper's Postman collection file

Use our Postman collection to kickstart your implementation. Postman is a widely-used API development tool that makes it even easier to start using Proper's API.

1. Download the collection file

You can download the file here:

Download collection file →

2. Import the collection

To begin, open the Postman app, which is available as a browser or desktop version. Once you launched the app, create or select a workspace and import the collection file.

To do so, simply drag the collection file into the application/browser window or click on 'Import'. After successfully importing, the collection appears under Collections.

3. Use the collection

To use the collection, navigate to the collection you just imported and click on 'Authorization'. Under Value, insert the API key you received. Then click on 'Save'. Now you’re ready to begin making requests.

Postman

All available API requests are already stored within the collection file, so you don't have to copy the calls from anywhere else. Simply insert the correct ID's for customer, agreements, invoices etc. in the URL whenever necessary (e.g. to list subscriptions on a specific agreement).

Read more about how to use Postman on their site (opens in a new tab).