Adding a Micro Gateway to a Catalog

If you are using the Micro Gateway, then to be able to route calls to APIs that are published to a Catalog, you must add the Micro Gateway to the Catalog.

Before you begin

Important: IBM® API Connect Micro Gateway is deprecated in IBM API Connect Version 5.0.8 in favor of DataPower® Gateway. From 1 April 2020, Micro Gateway, and associated toolkit CLI commands, will no longer be supported. Existing users can migrate their API definitions to IBM DataPower Gateways. For information on supported API policies, see Built-in policies.

About this task

You add the Micro Gateway to a Catalog by using the API Manager user interface.

For more information on Catalogs, see Working with Catalogs.

Procedure

To add a Micro Gateway to a Catalog, complete the following steps:

  1. If not already logged in, log in to the API Manager user interface.
  2. If you have not previously pinned the UI navigation pane then click the Navigate to icon The Navigate to icon.
    The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon The Pin menu icon..
  3. On the Dashboard page, click the Catalog to display details.
  4. Click Settings, go to the Gateway section, then click Configure Gateway.
  5. If you are using the Micro Gateway with the IBM API Connect Professional or Enterprise offering, complete the following steps:
    1. Select the API Connect collective to which you published the Micro Gateway application in Installing the Micro Gateway for the Professional and Enterprise offering, and click Next.
    2. Select the Micro Gateway application; this is the Micro Gateway application name that you specified in Installing the Micro Gateway.
    3. Paste the public key of the Micro Gateway, and click Done.
      You can obtain the public key from the id_rsa.pub file that you created in Installing the Micro Gateway.
  6. [V5.0.2 or later] If you are using the stand-alone Micro Gateway with the IBM API Connect Essentials offering, complete the following steps:
    1. Select API Connect Standalone Micro Gateway, and click Next.
    2. Paste the public key of the Micro Gateway application, and click Done.
      You can obtain the public key from the id_rsa.pub file that you created in Installing the Micro Gateway for the Essentials offering.
    3. Save the Catalog by clicking the Save icon The Save icon..
    4. Click the Download Configuration File link to obtain the YAML formatted environment manifest file env.yaml; this file contains information that is required by API Connect to communicate with the Catalog.
    5. Place the file in your API Connect application project folder.
  7. Click Endpoints, then, in the Custom Gateway URL field, enter the address of IBM HTTP Server or other load balancer for the API traffic.
  8. Save the Catalog by clicking the Save icon The Save icon..