Postman Collections

Example API requests with Postman™

Spot On provides a Postman™ API client collection of API requests to help you get started working with our endpoints without needing to write any code.

What is Postman?

Postman is an industry-standard tool for designing, building and testing API's and can be leveraged to make ad hoc calls to existing API's

Where can I get the SpotOn Postman Collections?

The postman collection for Transaction API (TAPI) can be found here.

How do I import the collection in Postman?

Copy the code in the code block for the API collection that you are working with to your clipboard.
Open Postman and select "Import" from within the workspace that you will be using the collection.

Select Raw Text from the tool bar along the top of the import modal

Paste the data that you copied into box and select Continue

Select Import to continue with importing the collection.

Once complete, you should see the collection in your workspace.

Once the import is complete you will need to edit the url for each of the calls to insert the base url that pertains to your specific project, and to add in your specific API key that is assigned to you for your project.

📘

Postman Help

For more information on using the Postman API Client, see the Postman documentation.

How do I make an API call with Postman?

After doing the initial collection setup above, open the desired API call on the left sidebar.
Verify that variables such as parameters, authentication, headers and JSON bodies are correct.
To submit your API call and see the results, click send.