Hybrid Integration 10.2 | Integrating On-Premises Applications | Document Conventions | Connecting to webMethods API Portal for Publishing REST API Descriptors | Configuring a Connection to API Portal | Adding a Connection Configuration for API Portal
 
Adding a Connection Configuration for API Portal
The number of connections to API Portal that you need to configure depends on the number of different tenants for which the REST API descriptors are to be published. For every tenant, you must create a unique connection configuration.
* To add a connection configuration for API Portal
1. In Designer, select Window > Preferences.
2. In the preferences navigation tree, select Software AG > API Portal.
3. Click Add.
4. In the Add Connection Configuration dialog box, enter the following information:
Field
Description
Name
The name to use for the connection configuration.
Note: The name cannot contain control characters, special characters, and characters outside of the basic ASCII character set, such as multi-byte characters.
Host
The host name of API Portal for the connection configuration.
Port
The port number on API Portal for the connection configuration.
User
The name of a valid user account on API Portal.
Password
The password for the specified User.
If required, you can omit the password at this time. In such a situation, API Portal prompts for the password each time your user authorization is required for connecting to API Portal.
Save password (in the Eclipse secure storage)
Indicates whether the password for the specified user account should be saved in Eclipse secure storage. API Portal uses this password from the Eclipse secure storage whenever user authorization is required. If you want to save the password in Eclipse secure storage, select this check box.
If you decide not to save the password in Eclipse secure storage, you must specify your password each time your user authorization is required for connecting to API Portal.
Tenant
The tenant for which the REST API descriptors are to be published.
Secure connection
Indicates whether the session for connection to API Portal is through HTTP or HTTPS. If you want to open an HTTPS session by using the Secure Socket Layer (SSL), select this check box. If you want to open an HTTP session, clear this check box.
5. To verify whether API Portal can be accessed by using the specified information, click Test.
6. To store the connection configuration details, click OK.
A connection configuration is added to the Connections page with the specified details. The first connection configuration that you create is automatically marked as default. This default configuration is indicated with a check mark on the Connections page. Designer always uses the default connection configuration for API Portal.
Copyright © 2015- 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release