CentraSite User's Guide : Runtime Governance : Gateway Management : Managing Gateways through CentraSite Business UI : Creating API Portal Gateway Asset
Creating API Portal Gateway Asset
To create and manage API Portal gateways, you must have the following roles:
*CentraSite Administrator: to create and manage API Portal gateways within any organization.
*Organization Administrator: to create and manage API Portal gateways within a specific organization.
*API Portal Administrator role for API Portal gateway
To establish communication between CentraSite and an API Portal gateway, you must first capture the configuration details of API Portal gateway, and then register (publish) the API Portal gateway with the CentraSite registry.
You define the configuration details of an API Portal gateway using the Add Gateway action in the Manage Governance Rules activity. If you do not see the Add Gateway action, it is probably because you do not have the required role to register the API Portal gateway with CentraSite.
To create an API Portal gateway
1. In the CentraSite Business UI activity bar, click Manage Governance Rules.
2. On the actions bar of the Search Results page, click Add Gateway.
3. In the Create New Gateway page, provide the required information for each of the displayed data fields:
In this field...
Do the following...
Name
Mandatory. Type a name for the new API Portal gateway. An API Portal name can contain any character (including spaces).
An API Portal name does not need to be unique within the registry. However, to reduce ambiguity, you must avoid giving multiple API Portals the same name.
As a best practice, consider adopting appropriate naming conventions to ensure that API Portal are distinctly named within an organization.
Description
Optional. Type a description for the new API Portal gateway. This description appears when a user displays a list of API Portal in the CentraSite Business UI.
Gateway
Select API Portal.
Organization
Select the organization to which this API Portal gateway is registered.
The drop-down list contains the list of rganizations to which you are permitted to add API Portals
Onboarding Consumer Organization
Select the organization to which the users of API Portal gateway is to be added.
*Use Existing (default): Select a previously existing organization.
*Create New: Type a new organization name.
Note:  
When this field is specified, CentraSite automatically associates the API Portal user with the specified organization during the user onboarding process.
4. Select the CentraSite Communication Information (API Portal to CentraSite) profile.
The CentraSite Communication Information is used to send events, metrics, and other information from API Portal to CentraSite.
Field
Description
Username
Mandatory. The CentraSite user ID for authenticating against the CentraSite when API Portal communicates with CentraSite.
This implies the user ID of a user who has the CentraSite Administrator role or the API Portal Administrator role.
Password
Mandatory. The password of the CentraSite user specified in the Username box.
Note:  
CentraSite Endpoint displays the URL (host and port) of the Software AG Runtime in http://host:port/ format. The host is the machine on which Software AG Runtime is running and port is the port on which Software AG Runtime is listening. The default Software AG Runtime port number for CentraSite is 53307.
5. Configure the API Portal Communication Information (CentraSite to API Portal).
Field
Description
Endpoint
Mandatory. The URL (host and port) of the API Portal gateway.
http://server:port/<WebAppContext>>
Where, server is the machine on which the API Portal is running and port is the port on which API Portal is listening.
Example
http://myServer:18101/abs
Tenant
Mandatory. Type the name of a tenant residing in the API Portal gateway.
By default, this field is populated with the default tenant that is pre-shipped with API Portal gateway.
Use CentraSite Credentials
Select the checkbox to enable reuse of the CentraSite credentials for authenticating against the API Portal gateway. When this checkbox is selected, CentraSite automatically disables the subsequent Username and Password fields.
Username
The API Portal user ID as configured in the UMC.
This implies the user ID of a user who has the API Provider role in the API Portal gateway.
Password
The password of the API Portal user specified in the Username box.
Sandbox
Optional. The sandbox category for classifying the API Portal gateway.
a. Click select. The select Sandbox Categories dialog appears allowing you to select the required categories for URL.
b. Select the checkbox beside the name of the category you want to use to classify the API Portal's URL.
c. Click OK.
CentraSite includes a set of predefined categories for the taxonomy node Sandbox, especially for classifying an API Portal gateway. By default, the gateway can be classified into these following predefined categories: Development, Production, Test.
For information on the Sandbox categories that CentraSite supports out-of-the-box, in CentraSite Control, go to Administration > Taxonomies. In the Taxonomies page, navigate to Sandbox in the list of taxonomies.
If you would like to use sandbox categories that are not supported by CentraSite, you can define your custom categories.
Note:  
Although it is possible to define subcategories for the predefined and custom categories within the Sandbox taxonomy, you cannot use these subcategories to classify the URL. CentraSite only displays the names of the top-level categories (that is, categories that are defined for the Sandbox taxonomy) for the classification.
6. Click Publish.
A gateway instance is created in the specified organization and registered with the CentraSite registry or repository. The API Portal gateway asset details page for the asset that you just created is displayed.
Copyright © 2015- 2017 Software AG, Darmstadt, Germany. (Innovation Release)
Product LogoContact Support   |   Community   |   Feedback