Skip to content


Accessing Application Functionality

Before subscribing to a particular API, developers or consumers can try it out. To successfully run the tryout, one needs Subscription Tryout Keys:

  • Public Key (X-Yappes-Subkey)
  • Private Key

These keys act as actual subscription keys for the tryout purpose.

By default, API Manager creates a Default Application that offers those keys. Every time the user tries out a particular API, it will use the keys of Default Application and APIs will be added to its list. The following is the Default Application, and it includes the APIs that users had the tryout of.

Default Application

Now, there are different types of APIs, and if one uses the Default Application, one won’t recognize its type once they tryout, because it will be added to the Default Application’s list. Therefore, to help the user easily recognize its type, they can create an Application of their own.

The next time they try an API, they will use that Application, and once the tryout operation is completed, it will be added to that Application. Users can later go and find the API easily and subscribe to it.

For example, there are multiple payments and loan APIs. So, if one uses the Default Application, then all the APIs will be added to it and it would become hard for the user to find the actual API they need for their purpose. However, if they create separate Applications, one for Payments and the other for Loans, then when they tryout Payment API, they will use the Payments Application and the API will be added to it.

Later, they can find it in the particular application. It also helps them categorize the APIs according to their requirements.

APIs Application Workflow

Furthermore, every request entering the Yappes platform is validated for the application key ("x-yappes-key"). Consumers need to send the application-key in their request as the "x-yappes-key" header value and Subscription Tryout Keys(public) as the "x-yappes-subkey" header.

If one uses the Applications Key ("X-Yappes-Key") of the Default Application for every request entering the Yappes Platform, then it will make monitoring the usage of the resources challenging as every API will be added to the Default Application. However, having different Applications for different requests based on the API type allows one to effectively measure the usage and set the quota accordingly.

Another reason why one needs to create an application is that if one needs to change or delete "X-Yappes-Key", then doing so in the Default Application affects all the APIs available in it, which the consumer or developer clearly wants to avoid.

Creating an Application provides the developer or consumer with the ease of:

  • Monitoring the API usage on an individual type level
  • Categorize the APIs of the same types into groups separate from API Groups
  • Deleting the X-Yappes-Key without affecting other APIs of different types
  • Regenerating X-Yappes-Key without affecting other APIs of different types

The following guides help you create, view, edit, use and delete the Application.

📄 Creating an Application

📄 How to View Details of the Application (APIs, Keys and Description)

📄 How to use an Application (Tryout Operation)

📄 Deleting an Application