Configuring webMethods API Gateway

Configure webMethods API Gateway to control how APIs are exposed, secured, and monitored.

About this task

Note: This procedure applies only to the IBM API Studio desktop application.

To deploy APIs to API Gateway, configure the gateway beforehand. IBM API Studio supports multiple gateway configurations, allowing selection of a specific gateway for API deployment.

Procedure

  1. Click API Studio settings on the home page to open the settings menu.
  2. Click Gateways > Add gateway.
  3. Provide the following gateway details:
    • Gateway name. Name of the API Gateway instance where you want to deploy the API.
    • Description. A brief summary of the gateway.
    • Tags. The tags that you want to specify for API Gateway that is being deployed.
    • Gateway URL. The URI of the webMethods API Gateway instance you want to configure. Use the following format:

      For a self-hosted instance of API Gateway: http://host:port where the port number you provide must be that of the IS port. For example, http://apigw01:5555. Use https if you are using a secure connection.

      For a cloud deployed instance: https://domain_name. For example, https://test.apigw-aw-eu.webmethods.io

    • Username. The username credential to access the API Gateway. Make sure that the user has Manage APIs functional privilege.
    • Password. The password credential to access the API Gateway.
  4. Click Add.
    The configured API Gateway appears in the list of the configured gateways. If the gateway URL or authentication details are invalid, the configuration fails with an appropriate error message.