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