Start of change
IBM Integration Bus, Version 10.0.0.5 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS


Pushing REST APIs to IBM API Connect by using the mqsipushapis command

Use the mqsipushapis command to create or update the definition of one or more deployed REST APIs on 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 mqsipushapis command to push (export) the definition of 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 deployed REST APIs to the IBM API Connect server:

  1. Use the mqsipushapis command to create or update the definition of your deployed REST APIs to an IBM API Connect server, as shown in the following example:
    mqsipushapis IBNODE -e default -t mysystem -g 443 -u testuser -a mypassword -o myOrg –c "MyCatalog" -r "MyProduct" –d "ProdName" –s 2.0.0 -k myapi1:myapi2:myapi3

    In this example, the following parameters have been set:

    IBNODE
    The name of the integration node. This parameter is required.
    -e default
    The name of the integration server where the REST APIs are deployed. This parameter is required.
    -t mysystem
    The host name of the IBM API Connect system. This parameter is required.
    -g 443
    The port of the IBM API Connect system. This parameter is required, and the specified value must be an integer between 0 and 65535.
    -u testuser
    The user name that is being used to connect to IBM API Connect. This parameter is required.
    -a mypassword
    The password that is being used to connect to IBM API Connect. This parameter is required.
    -o myOrg
    The name of the IBM API Connect organization where the APIs will be pushed. This parameter is required.
    -c "MyCatalog"
    The title of the IBM API Connect catalog where the product is to be staged (if required). This parameter is optional; if you do not set it, the product will not be staged.
    -r "MyProduct"
    The title of the IBM API Connect product to be created (or updated) and then staged. This parameter is required.
    -d "ProdName"
    The name of the IBM API Connect product to be created (or updated) and then staged. If you do not specify this option, the name of the product is derived from the title. The name can include only numbers (0-9), letters (a-z A-Z), dashes (-), or underscores (_). This parameter is optional.
    -s 2.0.0
    The version of the IBM API Connect product to be created (or updated) and then staged. If this parameter is not specified, the version number defaults to 1.0.0. This parameter is optional.
    -k myapi1:myapi2:myapi3
    The names of the APIs that will be pushed to IBM API Connect, separated by colons (:). This parameter is required.

    You can also set the following parameters:

    -x httpInboundProxyHost
    The host name and port of the proxy that receives the inbound HTTP request for the REST API that is running on IBM Integration Bus. The host name and port are separated by a colon (:). If no value is specified, the host name and HTTP port of the integration server are used.
    -y httpsInboundProxyHost
    The host name and port of the proxy that receives the inbound HTTPS request for the REST API that is running on IBM Integration Bus. The host name and port are separated by a colon (:). If no value is specified, the host name and HTTPS port of the integration server are used.
    -v traceFileName
    Sends internal debug trace information to the specified file.
    -w timeoutSecs
    The length of time (in seconds) that the utility waits to ensure that the command has completed. The default value is 60.
    For more information, see mqsipushapis command.
  2. When the command is run, the selected REST APIs are pushed to the IBM API Connect server.
    • If there is no existing API definition on the IBM API Connect server, a new API definition is 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 is replaced by the definition of your REST API.

Results

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

bn28906_.htm | Last updated 2016-06-25 08:09:03
End of change