Postman API Collection

The Viare API Postman collection provides a pre-built set of API requests that you can import directly into Postman, allowing you to quickly explore and test the Viare API without writing code.

ℹ️
The curated list of operations included in this collection cover the common use cases.
If you'd like to explore further, our full API reference can be found here.

Downloading the Collection

Download the Postman Collection for the Viare API here.

Importing into Postman

After you have downloaded the .json collection file:

Open Postman and go to the Import menu
Upload the downloaded JSON file

The collection should now be in your Postman workspace.

Using the Collection

Once imported, you'll have access to a series of requests, including documentation to help you understand the endpoint behavior.

Before making requests:

Set your Collection variables (see the Postman documentation for more information)
Authenticate to obtain your session token
Review and adjust the request body parameters as needed for your use case