How do I test an existing API?

Modified on Fri, 27 Apr 2018 at 10:29 AM

To try out a specific API, locate the API within the API Library list or by using with the search bar. Select the blue eye icon under the actions column. This will bring up a list of available consumers that can be authorized to use the API. Before you can try out an API for a specific consumer, you must authorize it by ensuring the authorize toggle is green and set to ‘ON’.

Once authorized, click “Try it Out” to bring up the demonstration interface and click on the API name to expand it. Once the API is expanded, it will display the input parameters and a basic response showing what the output format will look like. Add values to any required input parameters the API calls for. Next click execute to run the API  based on that input. Once executed the results will display with the server response and  the actual data your API would return.

Additionally, the “Try it Out” interface can provide code snippets in 9 different languages that can be used to run the API directly from external applications.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article