Use the API Explorer

Use the API Explorer to test or change an API resource by sending a request. You can also view the queries sent that generated the response as well as code samples. Any published API with a WADL attached to it is automatically pre-populated into the API Explorer.

Because authentication methods are used to control access to each API resource on the server side, valid credentials are required in order to test the API.

Picture 1.- API Explorer

To test APIs using the API Explorer:

After viewing the response in the Response tab (Picture 1.- API Explorer), you can choose the following actions:

The Query tab displays the following:

  1. On the navigation sidebar, click Resources to access the Resources page.
  2. Click API Explorer on the navigation sidebar. The API Explorer appears.
  3. Choose the API/WADL to use from the API menu. The API Key menu appears:
  4. To test an application with an API key, choose the application from the API Key menu. This pre-populates the API Key value and API Key secret of the chosen application in the Service Authentication dialog box.

    Note:If there is no API key for the application, a message appears stating that "No API key is available." In order to test an API key, the API key must be generated on the API Portal.

  5. Complete the following fields:

    Resource, Choose the resource for the selected API from the menu.   Method, Choose the method to use for the selected resource.
    Note: This list may or may not contain an entry as this field is optional. If no methods are displayed, the API Explorer defaults to using the GET method.
      Request tab, This tab is used to set the resource and method input parameters (if available).   Add Parameter, This control is under the Request tab. It displays the Add Parameter dialog box that is used to add additional parameters that are not otherwise specified in the WADL file.   Authentication. Displays the Service Authentication dialog box where you attach an authentication to the selected API. Note: The authentication type and requirement are not specified in the WADL file.

  6. Click Execute Request. The results are displayed in the Response tab.

After viewing the response in the Response tab, you can choose the following actions:

  • To view the request sent to the server, click Request.
  • To view the query sent to the server, click Query.

The Query tab displays the following:

  • Raw request that contains the HTTP request method
  • Full request URL, including the query parameters
  • Request headers
  • Request body (if available)
  • Code samples