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. |
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. |
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. |