Pushing a REST API to IBM API Management or IBM API Connect by using the IBM Integration Toolkit

Use the IBM® Integration Toolkit to create or update a definition for your deployed REST API on an IBM API Management or IBM API Connect server.

Before you begin

You must complete the following tasks:

Register your organization and the email address for the API owner with IBM API Management or IBM API Connect, depending on the version that you are using. For more information, see Developer sign-up in the IBM API Management product documentation, or Administering Developer organizations in the IBM API Connect product documentation.
Ensure that the IBM API Management or IBM API Connect server has a sandbox environment to which you can push the REST API.
Ensure that any firewalls allow the following connections:
- The IBM Integration Toolkit can connect to the IBM API Management or IBM API Connect server by using HTTPS.
- The IBM API Management or 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 push (export) your REST API to an IBM API Management or IBM API Connect server, which you can then use to perform the following tasks:

Promote and monitor the usage of the REST API.
Secure and authenticate access requests from external users and applications to your IBM Integration Bus application.

For information about supported versions of IBM API Management and IBM API Connect, see the IBM Integration Bus system requirements web page.

When you push a REST API to an IBM API Management or IBM API Connect server, you either create a new REST API definition or, if a REST API definition already exists on the server, you replace the latest revision of the REST API definition on the server with the definition of your REST API.

Note: The title of the REST API is used to identify the REST API definition on the IBM API Management or IBM API Connect server.

The REST API is pushed to the IBM API Connect or IBM API Management sandbox environment. You can then stage the API so that it is visible to application developers.

Procedure

In the IBM Integration Toolkit, navigate to your deployed REST API in the Integration Nodes pane.
Right-click the deployed REST API and click Push to IBM API Connect.
Enter the connection details for your IBM API Connect or IBM API Management server in the Host and Port fields.
Enter your credentials for accessing the server in the User ID and Password fields and click Next.
You can specify a blank value for User ID, in which case the IBM Integration Toolkit treats the password that you specify as an API key.

The organization (on the IBM API Connect or IBM API Management server) with which your credentials are associated, is identified.
Note: If your credentials are associated with more than one organization, you can select the organization that you want to use from the menu.
The presence or lack of an existing API definition with the same identification as your API definition is verified, and the details are displayed in the dialog.
Complete the task, depending on whether there is an existing API definition on the server:
- If there is no existing API definition on the server, a new API definition will be created for your REST API. Click Finish to confirm.
- If there is an existing API definition on the server, the latest revision of the existing definition on the server will be replaced by the definition of your REST API. Click Finish to confirm.
- If there is more than one API definition (with the same identification as your REST API) on the server, the process cannot complete. Either click Back and select a different organization, or click Cancel. Before you can replace the API definition on the server, you must remove the auxiliary instances of the API definition.

Results

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