Each API takes an XML document as input and returns another XML document as output. APIs can be asynchronous or synchronous.
- Security audits and logging
- Transaction control
- Achieving invocation-specific API behavior
For an asynchronous service, IBM Sterling Order Management automatically creates an instance of this object and passes it to each API part of the service. To programmatically invoke a synchronous service, you have to create an instance of this environment by calling the createEnvironment() API.
All APIs (whether standard or extended) have the same signature with respect to input parameters and return values. This signature is of the form
org.w3c.dom.Document APIName(YFSEnvironment env, org.w3c.dom.Document input);
In order for custom APIs to access custom values, the API should implement the
com.yantra.interop.japi.YIFCustomApi interface. If entered, these name/value pairs are passed to the
Custom API as a Properties object. For more information about the
com.yantra.interop.japi.YIFCustomApi interface, see the Javadoc.