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?