CentraSite provides a summary of details of the proxy PI. The details rendered as attributes are grouped together as profiles.
To view the details of a proxy API, the following prerequisites must be met:
The set of proxy APIs that are available to you are the APIs on which you have "View" permission. You can obtain "View" permission on a proxy 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 proxy APIs within a specified organization. |
| Modify Assets | View and edit all proxy APIs within a specified organization. |
| Manage Assets | View, edit and delete all proxy APIs within a specified organization, and set instance-level permissions on those APIs. This permission also allows you to create proxy APIs. |
| Create Assets | Add new proxy APIs to a specified organization. You automatically receive Full permission (which implies Modify and View permission) on all proxy APIs that you create. |
By having View, Modify or Full instance-level permissions on a proxy 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 proxy APIs in your organization. You can view proxy 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 proxy API in order to view it.
When you view the details for the API, you will only see profiles for which you have "View" permission.
For more information about permissions, see the CentraSite online documentation section Users, Groups, Roles and Permissions > About Roles and Permissions .
| Profile | Description |
|---|---|
| Basic Information | Contains basic information for a proxy API. This profile shows individual characteristic such as the proxy API's version, type, owner, organization and description. If you are having users watching or consuming the proxy API, CentraSite displays that information on this profile. This profile also contains controls for approving requests placed on this proxy API. |
| Advanced Information | Contains additional information for a proxy API. This profile shows the technical specifications, and the list of providers and consumers for the proxy API. |
| Technical Details |
Contains technical information for a proxy API.
|
| Provider Overview | Contains a link to the native API, and a list of Access URIs and API keys. |
| Consumer Overview | Contains usage information for a proxy API.
|
| Identification |
Applicable only for Application and API Key types. Provides consumer information for a proxy API, including the API key, expiration date of the API key, and the list of consumer identifier tokens associated with the particular API. This profile also contains control for re-configuring the consumer identifier tokens. For a list of the supported consumer identifier tokens, refer to the section Using Consumer Identifiers. Note: |
| API Key Scope |
Applicable only for API Key types. The name of the a proxy API that is associated with the API key. Note: |
| Runtime Metrics | Applicable only for XML/REST-based proxy APIs. Displays the run-time performance metrics associated with the proxy
API. If you are using webMethods Mediator, webMethods Insight or
another run-time monitoring component to log performance metrics for a proxy API,
CentraSite displays those metrics on this profile.
Note: |
| Runtime Events | Applicable only for Virtual 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.
Note: |
The following actions are available in the details page of a proxy API:
| 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. |
Use the following procedure to view the details for a proxy API.
To view the details of 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 properties as necessary.
CentraSite will display the attributes for the selected API. If you have Modify permission on the API, you can edit the API’s attributes.
