CentraSite Documentation : Working with the CentraSite Business UI : Managing Governance Rules : Using CentraSite with webMethods API-Portal : Registering an API-Portal Gateway with CentraSite
Registering an API-Portal Gateway with CentraSite
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. If you do not see the Add Gateway icon, it is probably because you not have the required role to register the API-Portal gateway with CentraSite.
To add and register an API-Portal gateway with the CentraSite registry, proceed as follows:.
To register an API-Portal gateway with CentraSite
1. In the activity bar, click Manage Governance Rules.
When you do this, you see a list of all of the currently registered API-Portal gateways. Also, the action bar shows the set of actions that are available for working with the available API-Portal gateways.
2. Click Add Gateway.
3. In the Add Gateway page, specify the following fields.
In this field…
Do the following…
Name
Mandatory. Enter 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 should 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. Enter 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
Choose API-Portal.
Organization
Choose the organization to which this API-Portal gateway will be registered. (The drop-down list will contain the list of organizations to which you are permitted to add API-Portals.)
Onboarding Consumer Organization
Choose the organization to which the users of API-Portal gateway will be added.
*Use Existing (default): Select a previously existing organization.
*Create New: Enter 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. To know more about the API-Portal user onboarding process in CentraSite, see Understanding Communication Between CentraSite and API-Portal .
CentraSite Communication Information (API-Portal to CentraSite)
You must set the communication parameters described in this section for API-Portal gateway to send and receive data with CentraSite.
Name
Description
Endpoint
CentraSite Endpoint shows the URL (host and port) of the Software AG Runtime in the format, http://host:port/. 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.
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 user specified in the Username field.
API-Portal Communication Information (CentraSite to API-Portal)
You must set the communication parameters described in this section for CentraSite to send and receive data with API-Portal gateway.
Name
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. Enter 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 as configured in the UMC. This implies the password of the user specified in the above Username field.
Sandbox
Optional. The sandbox category for classifying the API-Portal gateway.
a. Click Choose.
b. When you click the button, the Choose Sandbox Categories dialog appears allowing you to select the required categories for URL.
c. Mark the checkbox beside the name of the category you want to use to classify the API-Portal's URL.
d. 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.
4. Click Publish.
An API-Portal gateway is created in the specified organization, and the new API-Portal communication information is registered with the CentraSite registry/repository. The API-Portal gateway details page is displayed.
Copyright © 2005-2015 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback