CentraSite Documentation : Working with the CentraSite Business UI : Managing Governance Rules : Using CentraSite with webMethods API-Portal : API-Portal Specific Profiles in CentraSite : API-Portal Information Profile
API-Portal Information Profile
The Service asset type definitions (Service, REST Service, and XML Service) and its variants (Virtual Service, Virtual REST Service, and Virtual XML Service) contains a profile named API-Portal Information, which will display the classification details of an API in API-Portal.
The API-Portal Information profile is an optional profile that is disabled by default. When you add an API-Portal asset to the CentraSite registry, it is enabled for all Service asset type definitions.
This profile includes the following attributes:
Attribute
Description
API Proxy URLs
Specifies the URL of the proxy server through which requests are routed to the actual endpoint of the native service or the Mediator endpoint of the virtual service.
API Grouping
Groups the APIs by freely definable business terminology to indicate the API usage.
The following are some of the predefined categories in the API Grouping taxonomy in CentraSite.
*CRM
*Financing, Banking and Insurance
*Sales and Ordering
*Search
*Transportation and Warehousing
In addition to the predefined categories, you can create your own custom categories. For instructions on how to create a custom category, see the CentraSite Administrator’s Guide.
API Icon
Specifies the icon shown in API-Portal to represent the API.
API Maturity Status
Defines the maturity of your API based on a customizable set of terms, allowing you to indicate the maturity status for the API.
The following are some of the predefined categories in the API Maturity Status taxonomy in CentraSite.
*A Beta phase, the first stage of API maturity, when the features and functions of the API are currently undergoing beta testing.
*An Experimental phase is the next stage of API maturity, when the usage of an API is limited and focused on gathering feedbacks.
*A Test phase, when the features and functions of the API are undergoing testing in a controlled environment that mimics production scenarios.
*A Production phase is the final stage of API maturity, when the features and functions of the API are available publically.
In addition to the predefined categories, you can create your own custom categories. For instructions on how to create a custom category, see the CentraSite Administrator’s Guide.
API Subscription Terms
Specifies the category of the key assigned to the client to access the API based on subscription plans.
The following are some of the predefined categories in the API Subscription Terms taxonomy in CentraSite.
*Donationware - Usage of the API is free of charge, but users are encouraged to make a donation if they like the API and want to continue using it.
*Flat Fee - There is a fixed amount charged for unlimited use of the API for a limited period of time.
*Free - Usage of the API is free of charge.
*Freemium - Limited usage of the API for free, and then charge for the extra usage.
*Pay per use - Pay for usage of the API based on the transaction or volume.
In addition to the predefined categories, you can create your own custom categories. For instructions on how to create a custom category, see the CentraSite Administrator’s Guide.
List of Access Tokens
Read-only. Specifies the access tokens generated for clients who request them through API-Portal.
Supported Access Token Types
Read-only. Specifies the type of client authentication mechanism for the API.
The following client authentication mechanisms for supported for an API in CentraSite:
*API Key Authentication - The API's authentication requires using an API key.
*Basic Authentication - The API's authentication requires using Basic Access Authentication as described in RFC2617.
*Digest Authentication - The API's authentication requires using Digest Access Authentication as described in RFC2617.
*OAuth 1.0 Authentication - The API's authentication requires using OAuth 1.0 as described in RFC5849.
*OAuth 2.0 Authentication - The API's authentication requires using OAuth 2.0 as described in RFC5849.
*x-{other} - The API's authentication requires using another authentication method.
Deprecated
Marks the API as deprecated in API-Portal.
Copyright © 2005-2016 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback