Acerca de los archivos XML de salida y las plantillas para las API

Las API devuelven datos mediante dos tipos de archivos XML de salida que definen qué elementos y atributos necesita una API.

  • Archivo XML de salida - Define los límites externos de los datos que una API puede devolver. No modifique los archivos XML de salida.
  • Archivo XML de plantilla - Define los datos que devuelve una API para el registro especificado en el archivo XML de entrada y limita la cantidad de datos a un subconjunto del XML de salida. Puede modificar este archivo para incorporar un subconjunto de los atributos y elementos del XML de salida.
Nota: Los archivos de plantilla deben codificarse en formato UTF-8 .

Plantillas XML de salida

Muchas API utilizan una plantilla de salida correspondiente. La plantilla de salida está en formato XML y la lee una API con objeto de determinar los elementos y atributos para los que debe devolver. La plantilla de salida estándar define los elementos y atributos devueltos para una API específica. (Para ver todo el rango de valores posibles que puede devolver una API, consulte su XML de salida en Javadoc.) La plantilla estándar puede ser un subconjunto de todo el rango de valores devueltos, tal como lo determina el XML de salida en el Javadoc.

Nota: Asegúrese de que al añadir elementos y atributos a la plantilla de salida, utilice sólo los que se documentan en el Javadoc. Aunque las API pueden generar elementos y atributos adicionales, solo se admiten los que se documentan en el Javadoc.

Por ejemplo, la plantilla de salida estándar de la API getOrderList() devuelve la información de nivel de cabecera de una orden y la plantilla de salida estándar de la API getOrderDetails() devuelve información detallada sobre una orden.

Además de la plantilla XML de salida estándar, puede crear plantillas de salida personalizadas para API para utilizar sus propios requisitos empresariales, tales como una salida diferente para diferentes tipos de documentos.

Tipos de documento

Si utiliza una gama de tipos de documentos relacionados con la empresa tales como, órdenes, órdenes planificadas, órdenes de compra y devoluciones, puede utilizar plantillas personalizadas para permitir que una API devuelva los valores que pertenecen a cada tipo de documento exclusivo.

Por ejemplo, puede utilizar una plantilla con la API getOrderDetails() para devolver información sobre Órdenes Planificadas y otra plantilla para la API getOrderDetails( ) para devolver información diferente sobre Órdenes.

Comportamiento de plantilla de salida estándar

El conjunto de valores que la plantilla de salida estándar devuelve cubre una serie de escenarios de negocio. Con una gama tan amplia de posibilidades, una API que utiliza la plantilla de salida estándar puede devolver muchos más datos de los necesarios para los objetivos empresariales (y requerir mucho más tiempo para procesar del preferido).

Si desea personalizar la información que devuelve una API, puede hacerlo creando y utilizando una plantilla personalizada, mediante nuestras directrices y procedimientos.