Pushing REST APIs to IBM API Connect by using the web user interface

Use the web user interface to create or update a definition for one or more deployed REST APIs in IBM® API Connect.

Before you begin

You must complete the following tasks:
  • Register your organization and the email address for the API owner with IBM API Connect; see Administering Developer organizations in the IBM API Connect product documentation.
  • Ensure that the IBM API Connect server has a sandbox environment to which you can push the REST API.
  • Ensure that any firewalls allow the following connections:
    • IBM Integration Bus can connect to the IBM API Connect server by using HTTPS.
    • The IBM API Connect server can connect to the integration server by using HTTP or HTTPS.
  • Create a REST API in the IBM Integration Toolkit; see Creating a REST API.
  • Deploy the REST API to the integration server; see Packaging and deploying a REST API.

About this task

You can use the IBM Integration Bus web user interface to push one or more REST APIs to IBM API Connect. When you push the REST APIs to IBM API Connect, you either create a new REST API definition or, if the REST API definition already exists on the IBM API Connect system, you replace the latest version of the REST API definition with the new definition of your REST API.

Procedure

Follow these steps to push one or more REST APIs to IBM API Connect:

  1. In the web user interface, click the arrow next to the required integration server, and then click Push to API Connect.
    The Push REST APIs to API Connect dialog is displayed, in which you define your connection to the IBM API Connect system.
  2. Enter the connection details for your IBM API Connect server in the Host and Port fields.
  3. Enter your credentials for accessing the IBM API Connect server in the User ID and Password fields, and click Connect to API Connect.
    A connection is established to the IBM API Connect server.
  4. When the connection is established, click Next.
    A panel is displayed in which you can specify the target organization, product name, and version.
  5. Select the target organization into which the REST APIs will be pushed.
    The Organization menu shows a list of organizations on the IBM API Connect server to which you have access. These are the organizations with which your credentials are associated.
  6. Specify the name and version of the Product that you want to create or update. If you want to stage the product, specify the name of the Catalog to which you want it staged. If you do not specify a catalog, the REST API and product will remain in draft state.
  7. Click Next.
    A panel is displayed in which all available APIs are listed.
  8. Select the REST APIs that you want to push to IBM API Connect and add to the product, and then click Push to API Connect.
    The selected REST APIs are pushed to the specified product in IBM API Connect:
    • If there is no existing API definition on the IBM API Connect server, a new API definition will be created for your REST API.
    • If there is an existing API definition on the IBM API Connect server, the latest revision of the existing definition on the IBM API Connect server will be replaced by the definition of your REST API.
  9. Optional: You can override the host name and port that are used by IBM API Connect to invoke the APIs:
    1. On the Select the REST APIs to push to IBM API Connect panel, click Next.
      The Advanced configuration options panel is displayed.
    2. In the Advanced configuration options panel, specify an alternative address, such as the address of a proxy server or gateway to be used for connecting to IBM Integration Bus. You can specify the host name of a proxy server that is using HTTP or HTTPS, and the port that it is using.
    3. Click Push to IBM API Connect.

Results

Your REST API definition is created or updated on an IBM API Connect server.