CentraSite Documentation : Working with the CentraSite Business UI : Managing Governance Rules : Using CentraSite with webMethods API-Portal : API-Portal Information Profile in CentraSite
API-Portal Information Profile in CentraSite
 
Extending Asset Type Definition to Enable API-Portal Information Profile
Service asset types contain a profile named API-Portal Information which includes attributes that are used when API-Portals are registered CentraSite.
The Service asset types (Service, REST Service, and XML Service) and its variants (Virtual Service, Virtual REST Service, and Virtual XML Service) do not contain the API-Portal Information profile by default. An administrator can optionally choose to enable this generic profile in the asset type definition. For example, if API-Portal is used with CentraSite, an administrator might want to enable this profile for all APIs of type Service.
The API-Portal Information profile includes the following attributes:
Attribute
Description
API Maturity Status
Specifies the maturity status for the API.
CentraSite provides a number of standard taxonomy categories that you can use to specify the maturity phase of the API. These include:
*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 using the taxonomy categories that CentraSite provides, you can create your own custom categories.
API Grouping
Specifies the usage of the API.
CentraSite provides a number of standard taxonomy categories that you can use to group the API. These include:
*CRM
*Financing, Banking and Insurance
*Sales and Ordering
*Search
*Transportation and Warehousing
This grouping of APIs enables users to discover them easily.
In addition to using the taxonomy categories that CentraSite provides, you can create your own custom categories.
API Subscription Terms
Specifies the assignment of a key to the client to access the API based on subscription plans.
CentraSite provides a number of standard taxonomy categories that you can use to classify the API. These include:
*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 using the taxonomy categories that CentraSite provides, you can create your own custom categories.
API Icon
Indicates the icon that is used to represent the API in API-Portal.
Supported Access Token Types
(Read-only.) Specifies the type of client authentication required to consume the API.
CentraSite supports the following client authentication mechanisms:
*API Key Authentication
*OAuth 2 Access Token Authentication
*HTTP Basic Authentication
List of Access Tokens
(Read-only.) Displays the list of access tokens generated for clients that were requested through API-Portal.
Copyright © Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback