Skip to content
CA API Management SaaS
Documentation powered by DocOps

Test and Explore APIs

Last update September 27, 2018

As an administrators or API owner, you can test and explore the APIs you published on the CA API Management SaaS using the API Explorer. The API Explorer shows only the APIs that have WADL or Swagger .json files.

Note: In this release, Swagger files support git-flavored markdown.

You can select an API and can configure a query using API Explorer. The API Explorer uses information in a well-crafted WADL or Swagger .json file. The API Explorer displays information about the API, resource, method, and parameters that you select for the query. A request is submitted against the API from the API Explorer. The call is routed to the end point specified in the WADL or Swagger file. If multiple clusters of API proxies are present, you can point the end point that is specified in the WADL or Swagger file to a particular cluster or a virtual IP address.

Note: If the API you are publishing is secured using OAuth 2.0, ensure that the end point specified in the WADL or Swagger file is also specified in the Authentication section of the API Metadata tab.

When you send the query, the API Explorer displays the query string and the API results. The API Explorer can also display error messages.

You can translate the generated query into one of the following programming languages:

  • cURL
  • Java
  • JavaScript
  • Node.js
  • Objective C
  • PHP
  • Python
  • Ruby

Note: If you use Internet Explorer 11 with its default settings, you cannot use the API Explorer to consume an API that has OAuth 2.0 authentication. When you submit your credentials in the OAuth 2.0 authorization dialog, the dialog becomes blank and you cannot proceed. To work around this issue, use another browser or enable access to data sources across domains in Internet Explorer.

Follow these steps:

  1. Log in to the API Portal.
  2. Select one of the following methods: 
    • Use API Explorer. Select PublishAPI Explorer, and select an API.
    • Select Publish, APIs, select the menu icon for the API that you want to test, and then select Test.
  3. If the API requires authentication, perform the following substeps:
    1. From the App/API Key menu, select an application. The API Explorer uses the application API key and shared secret.

      Note: When using the Portal API or Metrics API in the API Explorer, select  Portal API app... from the App/API Key menu.
    2. Select Configure Authentication.
    3. Select the authentication type that the API requires.
      More fields appear. The fields depend on the authentication type.
    4. Complete the fields that the authentication type requires.
    5. Select OK.
  4. Select a resource in the API.
  5. Select a method available for the resource. If the method requires a parameter value, then enter a valid value.

    Note: API Portal supports application/json as the parameter content type. To view application/xml as the parameter type, manually convert the payload as an XML type, and paste as a body.

  6. (Optional) If you want to add another parameter that the API supports, then perform the following substeps:
    1. Select Add Parameter.
    2. Specify the parameter type: query, header, or template.

      Note: Template parameters are URI parameters that are enclosed in { }. Template parameters must be substituted before the URI can be resolved.
    3. Enter the parameter name and value.
    4. Select OK.
  7. Select Submit.
    The API Explorer displays the query that it sent to the API and the response from the API.
  8. To translate the query to another programming language, select the language from the menu.

To go from the API Explorer to the API Portal Home page, select the name of your API Portal.

Was this helpful?

Please log in to post comments.