In this field… | Do the following… | |||
Name | Mandatory. Enter a name for the API-Portal. 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 comment or descriptive information about the API-Portal. This description appears when a user displays a list of API-Portal in the CentraSite Business UI. | |||
Organization | Choose the organization to which this API-Portal will be registered. (The drop-down list will contain the list of organizations to which you are permitted to add assets.)
| |||
Consumer Organization | Choose the organization to which the users of API-Portal will be added. Use Existing (default): Select a previously existing organization. Create New: Enter a new organization name.
| |||
CentraSite's Communication with API-Portal | You must set the communication parameters described in this section for API-Portal to send and receive data with CentraSite. | |||
Name | Description | |||
Endpoint | The URL (host and port) of the Software AG Runtime. http://server:port/ Where, server is the machine on which the Software AG Runtime is running and port is the port on which Software AG Runtime is listening (port 53307 if CentraSite is configured to use the default Software AG Runtime port number). Example http://myServer: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's Communication with CentraSite | You must set the communication parameters described in this section for CentraSite to send and receive data with API-Portal. | |||
Name | Description | |||
Endpoint | The URL (host and port) of the API-Portal. http://server:port/ 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 | Enter the name of a tenant residing in the API-Portal. By default, this field is populated with the "default" tenant that is preshipped with API-Portal. | |||
Reuse CentraSite Credentials | Select the checkbox to enable reuse of the CentraSite credentials for authenticating against the API-Portal. 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 API-Portal. | |||
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. |