Calling integrations in the cloud

When an integration is running in IBM® Integration Bus on Cloud, you can interact with it from any applications that have access to the Internet.

Before you begin

Ensure that you have uploaded and started an integration in IBM Integration Bus on Cloud. For more information, see Running integrations in the cloud.

About this task

Your integrations might contain applications, integrations, or REST APIs that process information; these resources are called public endpoints. You can connect to these public endpoints so that you can begin processing information. When you view the contents of your integration, the URL is provided for each endpoint with which you can interact. You can enable basic authentication to ensure that your integrations that contain HTTP or SOAP nodes require a user name and password before they can be accessed.

Procedure

To call integrations in IBM Integration Bus on Cloud, complete the following steps.

  1. In the integrations view, click the relevant running integration to see its details.
  2. Expand the Public Endpoints section.

    The applications, integration services, or REST APIs that are part of your integration are listed. The host name is also specified. This host name is unique to the integration and does not change, unless you update and upload the integration again.

  3. Optional: If you do not want to secure access to HTTP and SOAP endpoints in your integrations, click OFF to disable basic authentication. To disable or enable basic authentication, your integration must be stopped. For more information about basic authentication, see Basic authentication. If basic authentication is enabled, you can complete one or more of the following optional steps:
    1. Optional: To view the password that is required to access HTTP and SOAP endpoints in your integration, click the view icon next to the Password field.
    2. Optional: To change the password that is required to access HTTP and SOAP endpoints in your integration, click Regenerate Credentials.
      A new password is created and the corresponding HTTP BasicAuth header is updated to use the new password.
    3. Optional: To view the HTTP BasicAuth header that is required by HTTP requests to HTTP and SOAP endpoints in your integration, click the view icon next to the HTTP BasicAuth header field.
  4. Expand the relevant application, integration service, or REST API.
  5. Click Show full URL next to the endpoint with which you want to interact.

    The full URL is a concatenation of the host name of the integration and the path of the selected endpoint. Use the full URL in a client to interact with that endpoint.

Results

You can now interact with your running integrations and send information for them to process. For an example of how to interact with an integration, see Exploring IBM Integration Bus on Cloud by using a sample.

What to do next

To set up network connectivity so that your integrations can communicate with on-premises applications, see Connecting securely to private endpoints.