CentraSite provides a summary of details of the virtual API. The details rendered as attributes are grouped together as profiles.
When you view the details of a virtual API in CentraSite catalog, keep the following points in mind:
The set of virtual APIs that are available to you are the APIs on which you have View permission. You can obtain View permission on a virtual API in the following ways:
By belonging to a role that includes any of the following permissions.
This permission... | Allows you to... |
---|---|
View Assets | View all virtual APIs within a specified organization. |
Modify Assets | View and edit all virtual APIs within a specified organization. |
Manage Assets | View, edit and delete all virtual APIs within a specified organization, and set instance-level permissions on those APIs. This permission also allows you to create virtual APIs. |
Create Assets | Add new virtual APIs to a specified organization. You automatically receive Full permission (which implies Modify and View permission) on all virtual APIs that you create. |
By having View, Modify or Full instance-level permissions on a particular virtual API.
By default, all CentraSite users belong to the Asset Consumer role. This role includes the "View Assets" permission for the organization to which a user belongs.
Having the "Asset Consumer" role gives you implicit view permission on all the virtual APIs in your organization. You can view virtual APIs from other organizations only if you are given permission to do so through the assignment of additional role-based or instance-level permissions.
In rare instances, an administrator might not grant view permissions to all of the users in an organization. If the administrator of your organization has done this, you will need instance-level permissions on a virtual API in order to view it.
For more information about permissions, see the CentraSite online documentation section About Roles and Permissions in the document Users, Groups, Roles and Permissions.
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: |
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: |
Use the following procedure to view the details for a virtual API (alias).
To view the details of a virtual API
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.
Click the virtual API’s hyperlinked name.
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.
The Provider Overview profile of a virtual API shows a link to the native API, and a list of Access URIs and API keys.
The Consumer Overview profile of a virtual API displays the following information:
For an instance of the SOAP API, this profile displays the Consumer Service WSDL / WSDL URL, and a list of Access URIs and API keys.
For an instance of the REST-based API, this profile displays a list of Access URIs and API keys.