Configuring Federated API Management communication

Federated API Management is a centralized control and monitoring system that oversees and manages the entire API management landscape that is deployed across multiple regions, including cloud and on-premises environments. You can connect Developer Portal to Federated API Management to control and manage the performance of Developer Portal effectively through Federated API Management.

1. Expand the menu options, select Administration, and click Federated API Management.
2. Provide the following details in the Developer Portal information section:
   • Runtime name. Name that you can use to view the Developer Portal instance in Federated API Management. If there are multiple runtimes in Federated API Management, provide a name that is applicable to this runtime.
   • Description and Tags. Information that is helpful to identify this runtime in Federated API Management.
3. Provide the following values in the Developer Portal deployment section:
   • Region and Location. Geographic details of the Developer Portal instance for accurate recognition.
   • Host. Hostname of Developer Portal.

     Providing these details are helpful in locating a runtime in Federated API Management.

4. Provide the Federated API Management URL value in the Federated API Management information field.
5. Select an authentication type.
   • basic. To configure a Federated API Management instance that is not in your current API Connect stack. For example, API Control Plane v11.1. Provide the following details:
     • User name and Password. Provide the authentication details required to access the Federated API Management application.
     • Truststore. Click Browse file to upload the truststore file that will allow a secured communication and provide its password.
   • API key. To configure a Federated API Management instance that is a part of IBM webMethods Hybrid Integration.
     • Instance Id. Provide the ID of the webMethods Hybrid Integration instance with which you want to configure the API Control Plane communication.

       You can view the instance ID from the Instance details page. From webMethods Hybrid Integration, go to the Subscriptions page. Find the product that you want to view and click View subscription details. The Instances tab opens and shows the instances for that subscription. Click the instance that you want to link to API Control Plane. The Instance details page of the selected instance appears. You can copy the instance ID from the Instance details page.

     • API Key. Provide the key created for generating the access token that is required for calling assets that are published in webMethods Hybrid Integration.

       Generate an API key for the Service owner or the Service user role to configure the webMethods Hybrid Integration communication. For information on creating API key, see https://www.ibm.com/docs/en/hybrid-integration/saas?topic=accounts-using-service-ids-api-keys.

   • mLTS. To configure the Federated API Management instance that is available in your current API Connect stack.
6. Turn on the Federated API Management communication slider to enable the communication between Developer Portal and Federated API Management.
7. Click Save.

   Developer Portal saves the configuration and is added as a runtime in Federated API Management.

   When the communication is enabled, Developer Portal starts sending updates like API update, API creation, and API deletion to Federated API Management in real time.

   Note: After you save the configuration and go away from the page, you cannot view the password by going back to the same configuration page. The password is masked and cannot be unmasked to view in the UI.