Software AG Products 10.7 | Using CentraSite | Runtime Governance | Gateway Management | Managing Gateways through CentraSite Business UI | Creating API Gateway Asset
 
Creating API Gateway Asset
Pre-requisites:
To create and manage (that is, view, modify, and delete) API Gateway assets for an organization, you must have one of the following roles:
*CentraSite Administrator: instances of API Gateway in any organization in CentraSite.
*Organization Administrator: instances of API Gateway in your organization.
*API Gateway Administrator: instances of API Gateway in the specific organization to which your API Gateway Administrator role applies.
To establish communication between CentraSite and an API Gateway instance, you must first capture the configuration details of the API Gateway instance with which you want to communicate, and then publish the CentraSite information to API Gateway.
You specify the configuration details of an API 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 Gateway asset in CentraSite.
*To create an API 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 Gateway asset.
An API Gateway name can contain any character (including spaces).
The API Gateway name must be unique within the registry. The API Gateway name cannot be the same as any existing API Gateway name.
Description
(Optional). Description of the API Gateway. This description appears when a user displays the list of API Gateway instances in CentraSite Business UI.
Gateway
Select API Gateway.
Organization
Name of an organization where you want to register this API Gateway asset. 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 Gateway asset.
4. In the CentraSite Communication Information (API Gateway to CentraSite) section, provide the following information:
Field
Description
Username
The CentraSite user ID for authenticating against CentraSite when API Gateway communicates with CentraSite.
This implies the user ID of a user who has the CentraSite Administrator role or the API Gateway Administrator role.
Note:
This user should have at least Modify permission to update details of the APIs published to this API Gateway. This user could also be part of the MyAPIGateway Synchronization Group created for this API Gateway. Users in the MyAPIGateway Synchronization Group will always have Modify permission on the API once it is published to API Gateway.
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 Gateway to CentraSite. This information is updated in the CentraSite Communication section under CentraSite Destination in API Gateway.
5. In the API Gateway Communication Information (CentraSite to API Gateway) section, provide the following information:
Field
Description
API Gateway Endpoint
The API Gateway's deployment endpoint, which is the endpoint that CentraSite uses to interact with API Gateway for deployment of Virtual Service assets.
The API Gateway Endpoint URL has the following format:
http://<host>:<port>
Example: http://myHostname:5555
API Gateway WebApp URL
(Optional). The Web application URL of API Gateway. For example, http://myHostname:9072.
Note:
Various aspects of the way API Gateway WebApp URL functions are as follows:
*If a value is specified for this attribute, then CentraSite uses this URL as the API Gateway Web application URL.
*If a value is not specified for this attribute, then CentraSite automatically populates the dynamic URL based on the value that was sent by API Gateway on publishing the API Gateway asset from CentraSite to the API Gateway instance.
*API Gateway sends the Web application URL based on the value specified in the Web application load balancer URL field in API Gateway (go to <Username> > Administration > General > Load balancer) as described in webMethods API Gateway Administrator's Guide. For example,
*if a value is specified for this field, API Gateway sends the defined Web application load balancer URL to CentraSite.
*if the value is not specified for this field, API Gateway sends the default hostname and port number as Web application URL to CentraSite. For example: http://myHostname:9072
Use CentraSite Credentials
Selecting the check box enables reuse of the CentraSite credentials for authenticating against API Gateway.
When you select the Use CentraSite Credentials check box, the subsequent Username and Password fields are automatically disabled.
Username
The Integration Server user who is permitted to publish assets to API Gateway. By default, users of the Integration Server's API Gateway Administrator group are permitted to publish assets to this gateway.
Password
The password for the Integration Server user specified in the Username box.
Sandbox
(Optional). The sandbox category that is to be used to classify this API 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 Gateway's URL.
c. Click OK.
CentraSite includes a set of predefined categories for the taxonomy node Sandbox classifying API Gateway.
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 Gateway asset instance is created in the specified organization, and registered with the CentraSite Registry Repository. The details page for the API Gateway asset that you just created is displayed. For each API Gateway asset that is successfully created, CentraSite creates a MyAPIGateway Synchronization Group, where MyAPIGateway is the name of the MyAPIGateway asset. You can then add users with access to API Gateway to this Synchronization Group to send metrics for all services. This group gets permissions for all services published to this API Gateway.
Note:
When trying to create and publish an API Gateway asset to the API Gateway instance, if the API Gateway instance is already registered with another instance of API Gateway asset, publish of CentraSite communication and SNMP configuration to this API Gateway instance fails. However, the API Gateway asset is successfully created in CentraSite.