Download Postman Collection
NOTE: due to limitations within the interface provided by postman, you could not see the Authorization header included in the code snippets. But you can it when generating code through the desktop application.
For easy to use sample API calls for each endpoint referred to in this documentation, open the links below to see and download our Postman Collection for the target environment:
Postman Collection for Sandbox: https://documenter.getpostman.com/view/4881861/TVssio9Z?version=latest
Postman Collection for Production: https://documenter.getpostman.com/view/4881861/T17J9SWD?version=latest
Environment for Postman Collection (Sandbox)
This collection requires a set of variables that are needed to authenticate each request through the Authorization header (this header is generated by a Auth configuration that comes within the collection). You will need to add values to each variable in a custom Environment.
Name Description
ACCESS_KEY The API key generated in your DevHub App dashboard
SECRET_KEY The secret key associated to the API key generated in your DevHub App dashboard
API_BASE_URL The URL of the DevHub server, without the triling forward slash, you want to reach
To use the collection, copy the necessary values from the DevHub portal.
To add these values to your Postman environment:
- Select the gear icon next to the Sovos Developer Hub – Simple Connect API environment name. If you don’t have this environment created yet, create it or import it.
- Select Sovos Developer Hub – Simple Connect API.
- For each variable, add the values from your Developer Hub portal in the Current value column.
- When you’re done adding all values, click Update.
And that’s it! Now you can send the requests and Postman will set up these to be authenticated using these environment variables.