API Portal Profile in CentraSite
The Service asset type contains a profile named API Portal Information that includes attributes that are of use when CentraSite is integrated with API Portal.
The API Portal Information profile includes the following attributes:
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. For example, Beta, Experimental, Test, or Production.
API grouping. Groups the APIs by a definable business terminology to indicate the API usage. For example, CRM; Financial, Banking, and Insurance; Sales and Ordering.
API subscription terms. Specifies the category of the key assigned to the client to access the API based on subscription plans. For example, Donationware, Flat Fee, Pay per use.
API icon. Specifies the icon shown in
API Portal to represent the API.
Supported access token types. Specifies the client authentication: API Key or OAuth2.
API Details on API Portal(s). List of URLs generated for API's details on the actual
API Portal to which the API is published to.
CentraSite provides a number of standard taxonomy categories that you can use to indicate the maturity status, grouping, and subscription terms for an API or you can create your own custom categories. For information about taxonomies and adding a category, see CentraSite User’s Guide.
API Portal Information profile is enabled for the Service asset types (Service, REST Service, and XML Service) and its variants (Virtual Service, Virtual REST Service, and Virtual XML Service) only when API Portal Gateway is created.
