Version 9.5 SP1
 —  Virtualizing APIs Using the CentraSite Business UI  —

Viewing the Details of a Virtual API

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


General

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

For more information about permissions, see the CentraSite online documentation section About Roles and Permissions in the document Users, Groups, Roles and Permissions.

Top of page

The Virtual API Profiles

Profile Description
Basic Information Provides basic information about the virtual API. This profile shows individual characteristic such as the virtual 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 virtual API. This profile shows the technical specifications, and the list of providers and consumers for the virtual API.
Technical Details Provides technical information about the virtual API. For a service virtual API, this profile includes the WSDL URL and a list of the operations and bindings. For an XML/REST virtual API, the profile includes the XML URL and a list of the resources.
Provider Overview Provides a link to the native API, and a list of Access URIs and API keys.
Consumer Overview Provides information about the consumption of the virtual API.

For a SOAP API, this profile displays the Consumer Service WSDL / WSDL URL, and a list of Access URIs and API keys. For a REST based API, this profile displays a list of Access URIs and API keys.

Runtime Metrics For Virtual XML & REST APIs. Displays the run-time performance metrics associated with the virtual 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.

Note:
The Runtime Metrics profile is displayed for virtual APIs regardless of whether you enable or disable it for the Service asset type. In other words, when you disable the Runtime Metrics profile for the Service asset type, CentraSite removes the profile from native APIs, but continues to display it for virtual APIs.

Runtime Events For Virtual XML & REST APIs. Displays the run-time events associated with the virtual 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.

Note:
The Runtime Events profile is displayed for virtual APIs regardless of whether you enable or disable it for the Service asset type. In other words, when you disable the Runtime Events profile for the Service asset type, CentraSite removes the profile from native APIs, but continues to display it for virtual APIs.

Top of page

View the Details of a Virtual API

Use the following procedure to view the details for a virtual API (alias).

Start of instruction setTo view the details of a virtual API

  1. In CentraSite Business UI, use either the Browse or Search feature to locate a virtual 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 virtual API’s hyperlinked name.

  3. On the virtual APIs’ details page, examine the properties as necessary.

    CentraSite will display the attributes for the selected virtual API. If you have Modify permission on the virtual API, you can edit the virtual API’s attributes.

    Viewing the Provider Overview Profile

    The Provider Overview profile of a virtual API shows a link to the native API, and a list of Access URIs and API keys.

    Viewing the Consumer Overview Profile

    The Consumer Overview profile of a virtual API displays the following information:

    graphics/consumer_profile.png

Top of page