Using Vahana Hub APIs

The Vahana hub dashboard displays all published APIs from different vendors, including Decimal Technologies. You can consume these APIs based on front-end application-specific requirements.

To consume an API, you first need to subscribe to it and then test it to ensure that it is working as expected.

You can subscribe to an API and then test it as follows:

Subscribing to an API

To consume an API, you first need to subscribe to it. After you subscribe to an API, you test and then consume it. After you subscribe to an API, you can customize it or change its name based on front-end application-specific requirements.

To subscribe to an API:

  1. In the Search box, enter the API’s name (For example:- GST_ADVANCED_AUTHENTICATION), and the dashboard displays the API.
  2. Under the API’s name, click Subscribe to successfully subscribe to the API.

Testing API

When you access an API, the vHub dashboard displays the API’s request body and response in different text areas. The dashboard displays the API’s request and response with default values. To test the API, you can change the default value and then check it for the successful response and the error code-based response.

To test the API:

  1. In the Search box, enter the API’s name (For example:- GST_ADVANCED_AUTHENTICATION), and the dashboard displays the API.
  2. Click the API’s name, and the dashboard displays the following:
    • API’s request body parameters with default values
    • API’s response body parameters with default values

Case1:- Let’s test the API for the successful GST number’s authentication.

Note: Assume, you have already subscribed to the API and want to test it.

  1. On the dashboard, click Try, and the Test Now button appears.
  2. Change the gstin parameter’s value to 24ACLPS2522A1Z1 and then click Test Now, and the API returns the result as follows:

Case2:- Let’s test the API for wrong GST number.

  1. Enter wrong GST number (For example:- 24ACLPS2522A1).
  2. Click Test Now, the API returns the following result:
Was this article helpful?
YesNo