Version 9.5 SP1
 —  API Management Solutions  —

Viewing the Details of an API

CentraSite provides a summary of details of the API. The details rendered as attributes are grouped together as profiles.

An action bar contains the list of operations that can be performed on that API.


General

When you view the details of an API in CentraSite catalog, keep the following points in mind:

Top of page

The API Profiles

Profile Description
Basic Information Provides basic information about the API. This profile shows individual characteristic such as the API version, type, owner, organization and description. If you are having users watching or consuming this API, CentraSite displays that information on this profile. This profile also contains controls for approving requests placed on this API.
Advanced Information Provides additional information about the API. This profile shows the technical specifications, and the list of providers and consumers for the API.
Technical Details Provides technical information about the API. For a SOAP API, this profile includes the WSDL URL and a list of the operations and bindings. For an XML/REST API, the profile includes the schema URL and a list of the resources.
Provider Overview Displays the list of native and virtual endpoints. In this profile, a native endpoint is represented by the Binding, and a virtual endpoint is represented as an Alias that identifies a specific Access URI (i.e., address where the virtual API is published).
Runtime Metrics For SOAP, XML & REST APIs. Displays the run-time performance metrics associated with the API. If you are using webMethods Mediator, webMethods Insight or another run-time monitoring component to log performance metrics for an API, CentraSite displays those metrics on this profile.
Runtime Events For SOAP, XML & REST APIs. Displays the run-time events associated with the API. If you are using webMethods Mediator, webMethods Insight or another run-time monitoring component to log run-time events for an API, CentraSite displays those events on this profile.

Top of page

View the Details of an API

Use the following procedure to view the details for an API.

Start of instruction setTo view details for an API

  1. In CentraSite Business UI, use either the Browse or Search feature to locate an API that you want to view. If you need information on how to browse or search the CentraSite catalog, refer to the section Browsing the CentraSite Catalog or Searching the CentraSite Catalog in the document Managing the CentraSite Catalog.

  2. Click the API’s hyperlinked name.

  3. On the APIs’ details page, examine the attributes as necessary. CentraSite will display the attributes for this API.

    Remember that you will only see the profiles for which you have View permission. If you have Modify permission on the API, you can edit the API’s attributes. For procedures, see Editing the Properties of an API.

    Viewing a Native/Virtual Endpoint

    The Provider Overview profile shows a list of the native and virtual endpoints for this API. In this profile, a native endpoint is represented by the Binding, and a virtual endpoint is represented as an Alias that identifies a specific Access URI (i.e., address where the virtual API is published).

    graphics/provider_overview1.png

Top of page