Comportamiento de la API

Cada API toma un documento XML como entrada y devuelve otro documento XML como salida. Las API pueden ser síncronas o asíncronas.

El parámetro de entrada YFSEnvironment representa un estado de ejecución bajo el que se está invocando esta API. Se utiliza para las tareas siguientes:

Registro y auditorías de seguridad
Control de transacciones
Lograr un comportamiento de API específico de la invocación

Para un servicio asíncrono, IBM® Sterling™ Order Management System crea automáticamente una instancia de este objeto y la pasa a cada parte API del servicio. Para invocar mediante programación un servicio síncrono, tiene que crear una instancia de este entorno llamando a la API createEnvironment().

Nota: En general, la entrada a las API no debe contener ningún elemento o atributo "BLANK". Un elemento en blanco se puede definir como un elemento que contiene todos los atributos con valores en blanco. Si pasa un elemento en blanco, el comportamiento de la API es imprevisible.

Todas las API (ya sean estándar o ampliadas) tienen la misma firma respecto a parámetros de entrada y valores de devolución. Esta firma tiene el formato

org.w3c.dom.Document APIName(YFSEnvironment env, org.w3c.dom.Document input);

Para que las API personalizadas accedan a valores personalizados, la API debe implementar la interfaz com.yantra.interop.japi.YIFCustomApi. Si se entran, estos pares de nombre/valor pasan a la API personalizada como objeto de propiedades. Para obtener más información sobre la interfaz com.yantra.interop.japi.YIFCustomApi , consulte el Javadoc.