4.6. View API Pack Documentation

Documentation related to an API Pack guides you through some important tasks that will help you start using the Pack. It contains detailed descriptions about how to make API calls through your applications.

To view API Pack Documentation:

  1. In the API Stores page, browse/search through the API Packs to find the API Pack for which you want to view documentation.

  2. Click the API Pack card. The API Pack Details page displays.

    API Pack Details

    Fig. 4.65 API Pack Details

  3. In the API Packs Details page, click the Documentation tab to view documentation related to the API Pack.

    Documentation tab

    Fig. 4.66 Documentation tab

4.6.1. View Sample Data

The Sample Data tab provides code examples that you can use to make a sample API request. It also displays the sample response that you can expect when you make the sample request.

To view Sample Data:

  1. In the API Stores page, browse/search through the API Packs to find the API Pack for which you want to view Sample Data.

  2. Click the API Pack card. The API Pack Details page displays.

    API Pack Details

    Fig. 4.67 API Pack Details

  3. In the API Packs Details page, click the Sample Data tab to view code examples related to the API Pack.

    Sample Data tab

    Fig. 4.68 Sample Data tab

Next Steps

In the next section, you will learn how to test on Sandbox environment.