What are API References?

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 how to use each API effectively and even allows you to test them directly within the documentation.

What Does the API Reference Include?

  1. Endpoint Details
    • Comprehensive documentation of all available API endpoints.
    • Information on HTTP methods (GET, POST, PUT, DELETE), URL paths, and supported parameters.
  2. Request and Response Examples
    • Ready-to-use sample requests and responses to help you structure API calls properly.
  3. Parameter Descriptions
    • Clear explanations of required and optional parameters (query, path, and headers).
    • Details on data types, formats, and default values.
  4. Try It Playground
    • Instantly test API endpoints with sample data.
    • Make real API calls directly from the documentation—no coding required!

Next Steps

  1. Browse API Endpoints for the features you need.
  2. Test API Calls using the interactive Playground.
  3. Start Building your integration with confidence!

The API Reference makes it simple to understand, test, and integrate Sandbox APIs. Start exploring it today!

Need Help?



    • Related Articles

    • 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 ...

    • 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 ...

    • 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 ...

    • 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 ...

    • How to receive Sandbox Updates

      The Changelog is a dedicated section in the Sandbox Developer Hub that keeps you informed about the latest updates, new features, bug fixes, and improvements in Sandbox APIs. It ensures you stay up-to-date with changes that could impact your ...