API Management 10.4 | Using CentraSite | Suite Usage Aspects | Using CentraSite with webMethods API Portal | CentraSite Profiles for API Portal Properties
 
CentraSite Profiles for API Portal Properties
CentraSite includes the following predefined profiles for grouping the API Portal properties:
*API Portal Information
*API Portal Communication
*CentraSite Communication
*Published APIs
API Portal Information
The profile appears in the details page of a Service asset instance and its variants (REST Service, OData Service, Virtual Service, Virtual REST Service, and Virtual XML Service). This profile includes classification details of the asset, when CentraSite is integrated with webMethods API Portal.
The API Portal Information profile includes the following attributes:
Attribute
Description
API Proxy URLs
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 API Grouping taxonomy contains the following predefined categories in CentraSite:
*CRM
*Financing, Banking and Insurance
*Sales and Ordering
*Search
*Transportation and Warehousing
In addition, you can create your own custom categories.
API Icon
An icon that would represent the API in API Portal.
API Maturity Status
The maturity status of the API based on a customizable set of terms.
The API Maturity Status taxonomy contains the following predefined categories 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, you can create your own custom categories.
API Subscription Terms
Specifies the category of the key assigned to the client to access the API based on subscription plans.
The API Subscription Terms taxonomy contains the following predefined categories 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 - 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, you can create your own custom categories.
List of Access Tokens
(Read-only). A list of the access tokens that were generated for the clients who requested for the API access through API Portal.
Supported Access Token Types
(Read-only). The type of client authentication mechanism for the API.
The possible client authentication mechanisms in CentraSite are:
*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.
Note: By default, this profile shows disabled in the Service asset type definitions. However, an administrator can enable this profile in the type definitions as required. For example, if API Portal is jointly used with CentraSite, administrator can enable this profile for all of the Service type definitions.
API Portal Communication
The profile appears in the details page of an API Portal gateway asset instance. This profile includes the communication details for the CentraSite instance to send and receive data with the API Portal instance, when CentraSite is integrated with API Portal.
CentraSite Communication
The profile appears in the details page of an API Portal gateway asset instance. This profile includes the communication details for the API Portal instance to send and receive data with the CentraSite instance, when CentraSite is integrated with API Portal.
Published APIs
The profile appears in the details page of an API Portal gateway asset instance. This profile includes a list of the APIs that were published to the API Portal instance, when CentraSite is integrated with API Portal.
Copyright © 2015- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release