How to use an application (Tryout Operation)

In this tutorial, you’ll learn how to use a created Application that allows you to add APIs to it. In order to use an application or add APIs to it, you need to run the Tryout operation. The Tryout Operation allows developers or consumers to test and understand different aspects of an API, such as functionality, performance and suitability, before they subscribe to it.

You can run the tryout operation for both published and unpublished APIs. Follow the instructions mentioned in the below sections to learn how to do it.

For published API

To use an Application and run the Tryout Operation for a published API, do the following:

• From the home screen of the API Manager, go to Marketplace → select API Listing.

• Then, select the API you need to run the Tryout Operation for and use the Application to add the API to it.

• Switch to the API Documents

• The API Documents includes details of:
  • Endpoints used.
  • Endpoint Path.
  • Endpoint Description.
  • Content type.
  • X-Yappes-Key.
  • X-Yappes-Subkey.
  • X-accept-version.
  • Custom Header.
  • Query Parameters.
  • Response Schema.
  • Remaining Tryouts.
  • API request examples using curl, JavaScript, Python, and PHP.

• Now, to run the Tryout, first, select the Application in the X-Yappes-Key of the Application you need to use X-Yappes-Key of.

• Then, click the Tryout operation.

• For this, you’d get the Request URL and Response. with Response and Header.

The API will be added to the Application. In order to view the API, you need to access the Application in the Manage APIs functionality of API Manager. Follow the steps mentioned on this page to learn how to view the APIs present in an application.

For unpublished API

Info

This section is for the users of Internal Organizations only. In order to run the Tryout operation for an unpublished API, you must be a user with the role of platform-admin, api-product-manager or api-developer.

To use an Application and run the Tryout Operation for an unpublished API, do the following:

• From the home screen, go to Manage APIs → select My APIs.

• From the available unpublished APIs, click for the API you need to run the Tryout operation.

• On the API details page, scroll down to the Manage Endpoints section and click Edit.

• Then, in the new window, click Tryout.

• This will open the Endpoint Tryout window with details of:
  • Endpoints used.
  • Endpoint Path.
  • Endpoint Description.
  • Content type.
  • X-Yappes-Key.
  • X-Yappes-Subkey.
  • X-accept-version.
  • Custom Header.
  • Query Parameters.
  • Response Schema.
  • Remaining Tryouts.
  • API request examples using curl, JavaScript, Python, and PHP.

• Now, to run the Tryout, first, select the Application in the X-Yappes-Key of the Application you need to use X-Yappes-Key of.

• Then, click the Tryout operation.

• For this, you’d get the Request URL and Response with Response and Header.

The API will be added to the Application. In order to view the API, you need to access the Application in the Manage APIs functionality of API Manager. Follow the steps mentioned on this page to learn how to view the APIs present in an application.