When the
integration service developer generates the JavaScript client API for an
integration service, the following events occur:
- JavaScript client API code is
generated from the definition of the existing integration service interface. You can use this
code in JavaScript applications to
call the integration service operations without
configuring the underlying communication mechanism. A JavaScript method is created for each integration service operation.
- A JSON/HTTP binding is added to the integration service so
that JSON (JavaScript Object
Notation) messages that are sent from the JavaScript client API can be processed by the integration service. The JSON/HTTP binding is
intended for use only by the JavaScript client API.
- A web page that describes the JavaScript client
API is generated. From the web page, the JavaScript developer can download or reference the JavaScript client API code and copy sample code
directly into JavaScript client
applications. The web page is accessed from the integration service URL.
Elements that are defined in the existing
integration service, such as shared variables and Java™ statics, also apply to the
integration service when the
integration service is called by the JavaScript client API.
If the integration service is updated after the JavaScript client API is generated, then the JavaScript client API file and the
associated web page are automatically updated when the integration service is saved.
Restrictions
The following restrictions apply to the JavaScript
client API that is generated from an
integration service description:
- Calling integration services by using the JavaScript client API is supported only from
clients that are initiated either by Node.js, or by a Google Chrome web
browser.
- JavaScript client API code can
be generated only from an existing integration service.
- If you are deploying a web browser-based JavaScript application, then the IBM® Integration Bus HTTP proxy servlet must be deployed
on the same web server as your JavaScript application. For information about the HTTP proxy
servlet, see HTTP proxy servlet overview.
- The SOAP/HTTP binding is not required in order for the integration service to be called by the JavaScript client API. However,
if the SOAP/HTTP binding is removed from an integration service, then the root URL for
the integration service is not available
and therefore the JavaScript
client API code and associated web page are not accessible.
Last updated Friday, 21 July 2017