CA API Developer Portal - 4.3.2

PDF
index saas 5.0.2 5.0 4.5 4.4 4.3.2 4.3.1 4.2
English

Manage APIs

You can publish and manage APIs using the  and API proxy. You can get information about the published APIs using the API Catalog and APIs page.
You can publish and manage APIs using the 
API Developer Portal
 and API proxy. You can get information about the published APIs using the API Catalog and APIs page.
You can also manage your APIs by way of the Portal API or use this API in your scripts for managing APIs.
For more information about the Portal API, see Portal API (PAPI).
In this article:
 
 
Examine APIs with the API Catalog
Administrators and API owners can get information about the published APIs using the API Catalog. The API Catalog shows the following information about each API:
  • Name
  • Public description
  • State
  • Version
  • Visibility
  • Number of applications using the API
To open the API Catalog, follow these steps:
  1. Select the 
    Services
     icon.
  2. Select 
    Publish
    , 
    API Catalog
    .
For more information about the API Catalog, see Browse the API Catalog - Publishers.
Examine APIs with the APIs Page and API Wizard
You can find and examine published APIs using the APIs page.
(New in 4.3.2) 
The APIs are listed in the Grid view Grid View by default. You can also switch to List view List View . The Grid view displays the API name, the description, and also enables you to see the number of Apps using this API and the latency in milliseconds (if Analytics is enabled). 
 API Grid View 
(New in 4.3.2)
 You can easily search for an API by entering the search string that contains the API name or description. This is a self predictive search, which means entering any three consecutive characters shows the name of the API.
Use the following filters and find information about each API:
  •  
    Portal State:
     The state of the API on the API Portal:
    • Enabled: 
      Organization administrators and developers can add enabled APIs to applications and applications can consume them.
    • Deprecated:
       Organization administrators and developers cannot add deprecated APIs to applications. If an API is already added to an application and the state of the API changes from 
      Enabled
       to 
      Deprecated
      , the application can continue to consume the API.
    • Disabled:
       Organization administrators and developers cannot add disabled APIs to applications. If an API is already added to an application and the state of the API changes from enabled to disabled, the application cannot continue to consume the API. If an API is already added to an API group and the state of the API changes from enabled to disabled, the following message appears on the Edit API Group page:
      This API Group contains disabled APIs and will not be available for applications of same organizations.
    • Unpublished: 
      Unpublished APIs are APIs that have been published on the API proxy. The API must be in the 
      Enabled
       state before organization administrators or developers can add it to their application and before their application can consume it.
  •  
    Visibility:
     A lock shows that the API is private. A private API is only available to organizations that have it in their account plan. APIs that do not have locks are public and available to all organizations. Publishers can access all APIs.
  •  
    Applications:
     The number of applications that have added the API.
    If an application has added an API, you might only be able to edit some of the API settings.
View the List of Applications that Have Added an API
On the APIs page, in the row of the API, select the number in the Applications column. The Applications page opens with a list of the applications to which an organization administrator or developer has added the API.
View the Details for an API
  1. On the 
    APIs
     page, in the 
    API Name
     column, select the name of the API that you want to view.
    The page with Overview information opens.
  2. View the information in the 
    Overview
     and 
    Deployment
     tabs.
View How and Where an API is Deployed in the Details Page
On the APIs page, select the name of the API to view the deployment details. A details page displays the 
Deployments
 tab with a list of proxies on which the API is deployed. APIs that are published but not deployed display the enrolled proxies with the
 Not Deployed
 label. 
For each proxy enrolled with 
API Portal
, the deployment state, deployment type, and the date and timestamp displays:
  •  
    Deployment State:
     When an API is deployed, undeployed, or edited, the deployment state is updated.
    The deployment states are:
    • Deployed (
      green
      ). The current version of the API on the 
      API Developer Portal
       is deployed to the API proxy shown.
    • Pending Deployment (
      yellow
      ). The deployment process is running. Deployment can take up to 2 minutes (6 minutes for the Hybrid solution).
      If the deployment state of the API changes on the API proxy while the API Details page is open, you can display the new deployment state faster by refreshing the browser. If an API has been stuck in the 
      Pending Deployment
       state for a long time, there might be an issue with the deployment to the specified proxy. For on-demand and scripted deployment types, select the deployment state link for a more detailed deployment response message.
    • Error (
      red
      ). If the API deployment state is in
       Error
       state, there is a deployment or connection problem with the specified proxy.
       To verify the state of a proxy, access the API Proxy Details page for each proxy. Then, check whether the APIs section is displaying a red 
      x
       icon. If so, there is a problem reaching the API proxy. Contact your system administrator in this case.  The red
       x
       icon on Proxy Details page does not apply to on-demand and scripted deployments.
      For on-demand and scripted deployment types, select the red 
      Error
       icon on the API Details page to view more details about the error.
  •  
    Deployment Type: 
    Deployment type determines how Portal published APIs are deployed to the proxy. The deployment type cannot be edited once APIs are deployed to the proxy. The deployment type is selected when adding an API proxy. A proxy supports the following deployment types:
    • Automatic
      Any changes to APIs are automatically deployed to the proxy.
    • On-Demand
      API deployments are triggered on-demand by calling the deployment APIs. You can access these APIs from the APIs page.
    • Scripted
      API deployments are integrated into your existing CI/CD workflow by using the deployment APIs and invoking them from your deployment script.
    For more information about the deployment API, see Manage API Deployments.
  •  
    Last Updated timestamp:
     The details page also displays the date and timestamp of the last deployment attempt. The timestamp is updated on successful and failed deployments.