Postman Guide

You can test our REST API in Postman using our pre-configured collection. This guide will help you get started with Postman and our API.

Postman Workspace

Getting Started

1. Import the Collection and Environment

1. Download our collection and environment from a Postman Workspace
2. Open Postman
3. Click “Import” and select both the collection and environment files
4. The collection will be imported with all necessary endpoints and example requests
5. The environment will be imported with placeholder/dummy values
6. Replace the dummy values with your credentials provided by the support team

2. Set Up Environment Variables

The environment includes the following variables for the sandbox environment:

• BASE_URL: The API base URL
• Origin: The required origin header
• Bearer_Token: Your authentication token

3. Request Headers

Each request in the collection is pre-configured with the required headers:

Origin: {{Origin}}
Authorization: Bearer {{Bearer_Token}}

Using the Collection

Making API Requests

1. Select the sandbox environment
2. Choose the endpoint you want to test
3. Fill in any required parameters
4. Click “Send” to make the request

Testing Different Scenarios

The collection includes examples for:

• Successful requests
• Failed requests
• Error handling

Best Practices

When using Postman with our API:

• Keep your environment variables secure
• Use the provided sandbox environment
• Test both success and failure scenarios
• Review the example requests in the collection

Troubleshooting

Common issues and solutions:

1. Authentication Errors

   • Check if your token has expired
   • Ensure you’re using the correct environment

2. Rate Limiting

   • Contact support if limits are too restrictive

3. Response Issues

   • Check the response status code
   • Review the error message
   • Verify request parameters