Software AG Products 10.7 | Using CentraSite | Runtime Governance | Gateway Management | Managing Gateways through CentraSite Business UI | Creating API Portal Gateway Asset
 
Creating API Portal Gateway Asset
Pre-requisites:
To create and manage (that is, view, modify, and delete) API Portal assets for an organization, you must have one of the following roles:
*CentraSite Administrator: instances of API Portal gateway in any organization in CentraSite.
*Organization Administrator: instances of API Portal gateway in your organization.
*API Portal Administrator: instances of API Portal gateway in the specific organization to which your API Portal Administrator role applies.
To establish communication between CentraSite and an API Portal gateway instance, you must first capture the configuration details of the API Portal instance with which you want to communicate, and then publish the CentraSite information to API Portal.
You specify the configuration details of an API Portal gateway using the Add Gateway action in the Governance Rules activity. If you do not see the Add Gateway action, it is probably because you do not have the required role to configure and register an API Portal gateway asset in CentraSite.
*To create an API Portal gateway asset
1. In the CentraSite Business UI activity bar, click 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:
Field
Description
Name
Name of the API Portal asset.
An API Portal name can contain any character (including spaces).
The API Portal name does not need to be unique within the registry. However, to reduce ambiguity, you must avoid giving multiple API Portal instances the same name.
As a best practice, consider adopting appropriate naming conventions to ensure that API Portal instances are distinctly named within an organization.
Description
(Optional). Description of the API Portal gateway. This description appears when a user displays the list of API Portal instances in CentraSite Business UI.
Gateway
Select API Portal.
Organization
Name of an organization where you want to register this API Portal gateway. This value is set to Default Organization.
The drop-down list contains the list of organizations to which you are permitted to register the API Portal gateway.
Onboarding Consumer Organization
Name of an organization where you want to add the users of API Portal gateway. This value is set to Default Organization.
*Use Existing (default): Select an existing organization.
*Create New: Type a new organization name.
Note:
CentraSite associates the API Portal user with the selected organization during user onboarding process.
4. In the CentraSite Communication Information (API Portal to CentraSite) section, provide the following information:
Field
Description
Username
The CentraSite user ID for authenticating against 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
The password of the CentraSite user specified in the Username field.
Note:
The CentraSite Endpoint field shows the URL (scheme, host, and port) of the CentraSite Application Server Tier (CAST) in the format, <scheme>://<host>:<port>. The scheme is http or https. The host is the machine on which CAST is running, and port is the port on which CentraSite is listening. The value for the CentraSite Endpoint field is determined by the URL that you use to access the CentraSite Business UI.
The CentraSite Communication Information is used to send run-time events, performance metrics, and other information from API Portal to CentraSite.
5. In the API Portal Communication Information (CentraSite to API Portal) section, provide the following information:
Field
Description
API Portal Endpoint
The URL (host and port) of API Portal instance.
The API Portal Endpoint URL has the following format:
http://<host>:<port>/<WebAppContext>
Example: http://myServer:18101/abs
Tenant
The name of a tenant residing in API Portal.
By default, CentraSite populates this field with the default tenant shipped with an instance of API Portal.
Use CentraSite Credentials
Selecting the check box enables reuse of the CentraSite credentials for authenticating against API Portal.
When you select the Use CentraSite Credentials check box, the subsequent Username and Password fields are automatically disabled.
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 API Portal.
Password
The password of the API Portal user specified in the Username field.
Sandbox
(Optional). The sandbox category that is to be used to classify this API Portal gateway.
a. Click Choose. The Sandbox dialog box displays the available sandbox categories.
b. Select the checkbox next to the name of the sandbox 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 classifying API Portal.
The available sandbox categories are:
*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 want 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.
An API Portal Gateway asset instance is created in the specified organization, and registered with the CentraSite Registry Repository. The details page for the API Portal Gateway asset that you just created is displayed.