API Testing

Test your API in Dev Console / Test Client.

Table of Contents

  1. What is Dev Console / Test Client?
  2. How do I access Dev Console / Test Client?
  3. How do I test my API in Dev Console / Test Client?

What is Dev Console / Test Client?

The platform includes an API testing interface that acts as an easy-to-use test client for any API that is fully integrated, with an API definition in the platform. This test tool allows developers to thoroughly test all capabilities of the API.

It can be used for prototyping, testing, and troubleshooting apps against an API. It includes OAuth support for retrieving the OAuth token in order to process the message.

In Default Theme, the tool is called Dev Console; in Simple Developer Theme, it is called Test Client.

As an API admin, it's a good idea to try your API out in Test Client before you publish, so you can see what experience app developers will have when trying out your API.

Back to top

How do I access Dev Console / Test Client?

Test Client is available in two places, one for app developers and one for API admins:

To construct the Simple Developer URL for an API Test Client:
  1. Take your Simple Developer platform URL, up to and including the #! in the URL, but delete everything after that.
  2. Get your APIID and APIVersion ID. If necessary, you can get these from Default Theme by going to the API Details page (APIID is shown in the URL) and clicking Edit (APIVersion ID is added to the URL).
  3. Construct the URL by adding the following after the portion of the URL that you already have:

    apis/<APIID>/versions/<APIVersionID>/testclient

    For example, the URL might be:

    http://{hostname}/#!apis/9add5c43-d9c8-443c-b13f-5388eaf95df8.acmepaymentscorp/versions/f9c0846f-c4b5-4a42-b759-2f92de62aaa4.acmepaymentscorp/testclient

  4. Paste the URL in the address bar and click Enter to go to the Test Client page for your API in Simple Developer theme. You can now put in sample values to test your API.

Back to top

How do I test my API in Dev Console / Test Client?

To test your API in Test Client, you can access it as an app developer or as an API admin. For instructions, see How do I access Dev Console / Test Client? above.

As an API admin, it's a good idea to test:

For general info on the settings available, and where different values are set up, refer to the app developer help, reference section: Test Client: Configuration Values.

Back to top