Test APIs on our Documentation
The Sandbox Developer Hub is an interactive documentation that also has an API Playground that allows you to test APIs directly within the documentation. This feature eliminates the need to set up a separate testing environment, making it easy to validate requests, experiment with parameters, and see real-time responses.
Steps to use the API Playground
- Navigate to the API Reference
- Go to the Sandbox Developer Hub and open the API Reference section.
- Select the API endpoint you want to test.
- Fill in Parameters
- Input values for required parameters (query, path, body) in the provided fields.
- Use sample values or your actual data to test specific scenarios.
- Provide Authentication
- Enter your API Key and Access Token in the headers x-api-key and authorization.
- Make sure you’re using the correct credentials for the Test or Live environment.
- Send the Request
- Click the Try It button to make the API call.
- The Playground sends the request to the Sandbox API and retrieves the response in real-time.
- Review the Response
- View the response body, headers, and status code in the results section.
- Analyze the data to ensure it meets your expectations or debug if necessary.
Need Help?
Related Articles
Sandbox Test Environment
The Sandbox Test Environment is a secure and isolated setup that allows users to test and validate API integrations before going live. It helps you simulate workflows, verify API behaviour, and troubleshoot issues without affecting real-world data or ...
What are API References?
Before starting development, it's essential to understand the APIs you’ll be integrating and perform basic testing. The API Reference in the Sandbox Developer Hub is your go-to technical guide for all Sandbox APIs. It provides detailed information on ...
Forking Postman Collection
Sandbox maintains a Postman Workspace with all our APIs neatly organized into public collections. This is where you can explore and interact with all the APIs we offer for simplifying your tax compliance and KYC needs. Forking a collection allows you ...
What are Guides?
The Guides section in the Sandbox Developer Hub is designed to help you quickly understand and integrate Sandbox APIs. With clear instructions and links to essential resources, it simplifies the process of getting started and using Sandbox APIs ...
What are Recipes?
Recipes are step-by-step instructions designed to help you solve real-world problems using Sandbox APIs. Just like cooking recipes guide you through preparing a dish, Sandbox API recipes guide you through making successive API calls to accomplish ...