CentraSite provides a summary of details of the API. The details rendered as attributes are grouped together as profiles.
When you view the details of an API, keep the following points in mind:
The set of APIs that are available to you are the APIs on which you have View permission. You can obtain View permission on an 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 APIs within a specified organization. |
| Modify Assets | View and edit all APIs within a specified organization. |
| Manage Assets | View, edit and delete all APIs within a specified organization, and set instance-level permissions on those APIs. This permission also allows you to create APIs. |
| Create Assets | Add new APIs to a specified organization. You automatically receive Full permission (which implies Modify and View permission) on all APIs that you create. |
By having View, Modify or Full instance-level permissions on a particular 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 APIs in your organization. You can view 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 an 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.
To view details for an API
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.
Click the API’s hyperlinked name.
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.
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).
Profiles represent a logical grouping of the information for an API.
The following profiles are available in the API details page:
| 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 defined for the 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). This profile also contains control for viewing the enforcement definition of a virtual endpoint. |
| Consumer Overview | Displays a list of all virtual endpoints defined for the 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 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. |
An action bar on the details page of an API contains the list of operations that can be performed on the API.
The following actions are available in the API details page:
| Action Name | Icon | Usage |
|---|---|---|
| Save |  |
You use this action to save the change made to an API's information. |
| Edit |  |
You use this action to view an API's information and modify them. |
| Version |  |
You use this action to generate a new version of an API. |
| Delete |  |
You use this action to remove an API. |
| Virtualize |  |
You use this action to create a virtual copy of an API. |
| Attach |  |
You use this action to attach a supporting document to an API. |
| Watch |  |
You use this action to subscribe notifications when changes are made to an API's information. |
| Add to List |  |
You use this action to add an API to the My Favorites list. |
| Remove from List |  |
You use this action to remove an API from the My Favorites list. |
| Export |  |
You use this action to export an API from one instance of CentraSite to another. |
| Consume |  |
You use this action to register as a consumer for an API. |
| Revert |  |
You use this action to revert an API request than has been submitted for approval. |
| View Report |  |
You use this action to generate and view reports for an API. |
| Permission |  |
You use this action to assign instance-level and profile-level permissions on an API. |
| API Consumption Settings |  |
You use this action to configure the client consumption settings for an API. |
| Publish |  |
You use this action to publish an API to the Mediator for consumption. |
| Unpublish |  |
You use this action to unpublish an API from the Mediator. |
