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
- 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.
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.