CA API Developer Portal - 4.4

PDF
index saas saas.staging 4.5 4.4 4.3.2 4.3.1 4.2 4.1 4.0
English

Test and Explore APIs

As an administrators or API owner, you can test and explore the APIs you published on the  using the API Explorer. The API Explorer shows only the APIs that have WADL or Swagger .json files.
As an administrator or API owner, you can test and explore the APIs you published on the 
API Developer Portal
 using the API Explorer or the Swagger UI. The API Explorer and Swagger UI only display APIs that have WADL or Swagger .json files.
API Explorer is only accessible through the API Portal/Ingress tenant. If you are using an external tenant, test and explore APIs using the Swagger UI instead.
You can select an API and can configure a query using API Explorer or Swagger UI. This function uses information in a well-crafted WADL or Swagger .json file and displays information about the API, resource, method, and parameters that you select for the query. A request is submitted against the API and a call is routed to the endpoint specified in the file. If multiple clusters of API proxies are present, you can point the endpoint that is specified in the WADL or Swagger file to a particular cluster or a virtual IP address.
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 or Swagger UI displays the query string and the API results. It 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
Test and Explore API using API Explorer
To test and explore an API using API Explorer:
  1. Log in to the API Portal.
  2. Select 
    one
     of the following methods:
    • Use API Explorer. Select 
      Publish
      , 
      API 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.
       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.
    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.
       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.
Test and Explore API using Swagger UI
To test and explore an API using Swagger UI:
  1.  Navigate to 
    Publish > APIs
    . 
  2.  Select the API you wish to view. The 
    API Details
     page opens. 
  3.  Click the 
    Spec 
    tab to open the Swagger UI. 
  4. Ensure your session is authorized. 
    If applicable, the 
    Padlock
     button next to your selected endpoint indicates whether an endpoint is locked. If required, authorize your session by clicking the 
    Padlock
     button and completing the information required in the 
    Authorization
     window.
  5. Expand your selected endpoint, and click 
    Try it out
    .
  6. The example values in the 
    Request Body
     field becomes editable. Make changes to the example request, and click 
    Execute
    .