IBM Integration API

The IBM® Integration API is a remote programming interface that your custom integration applications can use to control integration nodes and their resources.

The IBM Integration API consists solely of a Java™ implementation. Your custom integration applications have complete access to the IBM App Connect Enterprise functions and resources through the set of Java classes that constitute the IBM Integration API. In IBM App Connect Enterprise Version 11, the JAR file IntegrationAPI.jar supplies the classes, which are in the package. For ease of migration, applications developed before Version 11 can use the classes in the package; however, these classes are now deprecated and the classes are used instead.

Use the IBM Integration API to interact with integration nodes and servers to perform the following tasks:

  • Deploy BAR files
  • Change the integration node configuration properties
  • Create, modify, and delete integration servers
  • Inquire about the status of an integration node and its associated resources, and be informed if the status of any of the following items changes:
    • Integration servers
    • Deployed message flows
    • Deployed files that are used by the message flows (for example, JAR files)
  • Create and modify message flow applications

To view the Javadoc for the IBM Integration API, see IBM Integration API.

For the Java user-defined node API, which applies to user-defined nodes and to Java code that is called by JavaCompute nodes, see Java user-defined extensions API information.

Interaction between custom integration applications and the integration node

For applications that interact with the integration node, the Java classes sit logically between the user application and the integration node, inside the Java Virtual Machine (JVM) of the user application.

The diagram is described in the surrounding text.

The custom integration application can be on the same physical machine as the integration node, or on a remote machine. If a connection is made to a remote machine, the connection is made through the web administration port; for more information, see Configuring the IBM App Connect Enterprise web user interface.

Migrating from earlier versions of IBM App Connect Enterprise and IBM Integration Bus

For information about migrating your custom integration applications from a previous version to the current version of IBM App Connect Enterprise, see Migrating custom integration applications.