IBM Integration Bus, Version 10.0.0.2 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS


Pushing a REST API to an IBM API Management server

Create or update a definition for your deployed REST API on an IBM® API Management server.

Before you begin

You must complete the following tasks:
  • Register your organization and the email address for the API owner with the IBM API Management console; see Developer sign-up in the IBM API Management product documentation.
  • Ensure that the IBM API Management server, the IBM Integration Toolkit, and the integration node where the REST API will be deployed are all on the same network.
  • Ensure that the IBM API Management 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 server by using HTTP or HTTPS.
    • The IBM API Management server can connect to the integration server by using 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

If you push (export) your REST API to an IBM API Management server, you can use the IBM API Management server to perform the following tasks: For information about supported versions of IBM API Management, see the IBM Integration Bus system requirements web page.
When you push a REST API to an IBM API Management server, you either create a new REST API definition or, if a REST API definition already exists on the IBM API Management server, you replace the latest revision of the REST API definition on the IBM API Management 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 server.

The REST API is pushed to the IBM API Management sandbox environment. You can then use the API Manager user interface to create a plan, add the REST API to the plan, and test the API by using the integrated test tool. When you have verified that the REST API is defined and implemented correctly, you can publish the plan so that the REST API is visible to application developers.

Procedure

  1. In the IBM Integration Toolkit, navigate to your deployed REST API in the Integration Nodes pane.
  2. Right-click the deployed REST API and click Push to API Management.
  3. Enter the connection details for your IBM API Management server in the Host and Port fields.
  4. Enter your credentials for accessing the IBM API Management server in the User ID and Password fields and click Next. The organization (on the 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.
  5. Complete the task, depending on whether there is an existing API definition on the IBM API Management server:
    • If there is no existing API definition on the IBM API Management 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 IBM API Management server, the latest revision of the existing definition on the IBM API Management 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 IBM API Management 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 IBM API Management server, you must remove the auxiliary instances of the API definition.

Results

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

What to do next

Check that your REST API is defined and implemented correctly by adding the REST API to an IBM API Management plan, and then using the integrated test tool in the API Manager; see Testing an API with the API Manager test tool.

bi26100_.htm | Last updated 2015-09-24 12:54:16