Guía de Integración de Sistemas para el comprador

Transcripción

1 Documentación EDI WebService Compradores Proyecto: Guía de Integración de Sistemas para el comprador Preparado para: Bionexo Internacional Preparado por: Daniel Rocha Fecha Creación: 21 de Julio de 2009 Fecha ultimo cambio: 13 de noviembre de 2015 Numero del Documento: Versión: 1.6

2 Índice de versiones Versión Fecha Autor Revisor Descripción /07/2009 Daniel Rocha Daniel Rocha Preparación y traducción de las especificaciones funcionales /06/2010 Daniel Rocha Daniel Rocha Creación de índice de versión, revisión de los parámetros /03/2011 Daniel Rocha Daniel Rocha Creación de la operación WIP e revisión de ortografía /04/2011 Daniel Rocha Daniel Rocha Creación de la operación WOP, WMG e WFG. Actualización de la operación WAU /12/2011 Saincler Silva /11/2015 Carina Nagano Daniel Rocha, Diana Marin Traducción para Español. Inclusión da Operación WFU y url para entornos de prueba Colômbia e México /11/2015 Carina Nagano Inclusión de Flujos WCG, WDG y WEG. 2

3 ÍNDICE: Sumário 1 Objetivo Definición Métodos y Devoluciones Operaciones y Parámetros... 8 Operación: WAU Cambia la solicitud de cotización ya publicada, en análisis o Confirmado... 9 Operación: WASE Crea solicitud de cotización en espera Operación: WBS Crea solicitud de compra (artículos cotizados) Operación: WBSC Crea carrito de compras (Pre-solicitud) Operación: WCG Recupera Respuestas (Artículos y cotizaciones) Operación: WDG Recupera Carrito de Compras (Pre-solicitud) Operación: WEG Recupera Solicitud de Compras Operación: WIP Catastro / alteración de Productos Operación: WMG Recupera Proveedor(es) Operación: WFG Recupera Contratos Operación: WFU Actualización de Contratos Operación: WOP Registrar Ocurrencia para el proveedor Entornos

4 1 Objetivo 2 Definición Definir tecnologia utilizada para cambio electronico de informaciones. Especificar los métodos utilizados para a comunicación entre los sistemas involucrados y identificar posibles devoluciones para los métodos utilizados. Describir las posibles operaciones. Definir entornos para homologación, desarrollo de la tecnologia, y determinar el entorno que será utilizado para integración. Tecnologia utilizada en esta integración (sistema cliente X Bionexo) es basada en SOAP Web Service utilizando los métodos y parámetros llamados pos los protocolos HTTP (puerta 80) y HTTPS (puerta 443) para la comunicación. 4

5 3 Métodos y Devoluciones Sigue abajo la descripción de los métodos y devoluciones disponibles para la comunicación con la descripción de los métodos y devoluciones disponibles para la comunicación con Bionexo. - String request (String user, String password, String operation, String parameters, String xml) Método general para todos operaciones de despacho (POST). Los parámetros deben ser despachados como el estandar que se describe para HTTP o HTTPS. El archivo XML de despacho debe estar solo en una string o objeto DataHandler. La devolución y despacho es hecho por medio de un bloque estandar que varia con la operación y parámetros despachados que se describe abajo: String request (user, password, String operation, String parameters, String xml) Ejemplo: request (teste,1234,was, LAYOUT=WA, <XML file/>) - String request (String user, String password, String operation, String parameters) Método general para todas las operaciones de búsqueda de infromación (GET). Los parámetros deben ser despachados como el estándar que se describe para HTTP o HTTPS. La devolución es hecha por medio de bloque estándar que varía con la operación y Parámetros despachados que se describe abajo: Montaje del método: String request (User, Password, String operation, String parameters) Ejemplo: String request (teste,1234,was, LAYOUT=WE;TOKEN=1234) - Bloque estándar de devolución La devolución para los métodos es una string que separa cada valor contenido por punto y coma (;) con las informaciones que sigue: 5 STATUS Es la bandera del resultado para el método que fue invocado. Si el valor es menor que cero, significa que hubo un error. Si el valor es igual a cero significa que fue bien procesado, pero no se ha encontrado ningún dato. Si el valor es mayor que cero significa que fue bien procesado y que los datos fueron encontrados.

6 Mensaje Varia de acuerdo con la operación llamada, esta mensaje de respuesta puede contener una o varias informaciones diferentes. Si tiene error (STATUS<0) la mensaje tendrá siempre un texto de error (ejemplos abajo) o excepciones del sistema. En el caso de ningún dato encontrado (STATUS = 0) tendrá un señal de devolución, pero, sin ninguna información (vacío) en el lugar del XML. La descripción de los valores de devolución contenidos en el campo del mensaje están descriptos junto a las operaciones. Ejemplo= 1;123456;<XML/> 1; 20/12/ :00:01;<XML/> 0; 20/12/ :00:01;null" 0;123456;null" Errores= -1 ; 01/01/ :00:00 ; Incorrect login/password -1 ; 01/01/ :00:00 ; Número de acessos por minuto ultrapassado -1 ; 01/01/ :00:00 ; null NullPointerException -1 ; 01/01/ :00:00 ; Connection is closed -1 ; 01/01/ :00:00 ; UnsupportedOperationException (tentativa de llamar método no soportado para Operación) -1;15/06/ :19:55;Operation [WDD] not found (Cuando el parámetro de la operación no fue encontrado) 6

7 Bionexo Flujo: Cambio de datos entre server y client. login request (operation, parameters, xml) ID request (operation, parameters) XML 7

8 4 Operaciones y Parámetros La operaciones deben ser despachadas en momento de la llamada de los métodos con una de las strings aceptas por el servicio. Los parámetros están directamente relacionados a las operaciones. Un método solamente puede contener una operación y una operación puede tener múltiples Parámetros. Abajo detalles de las operaciones posibles y Parámetros aceptos y sus devoluciones: Operación: WAS Crea solicitud de cotización directa Crea solicitud de cotización directa, que es publicada así que el método y parámetros son despachados. Separador: Punto y coma (;). Ejemplo del despacho de múltiples parámetros: LAYOUT=WA;XML LAYOUT Determina el layout que será generado (XML). Valor estándar = WA Formato posible = WA XML Datos generados según el esquema WA. Formato = Despachado separadamente schema (PDC_WA.xsd) y archivo de ejemplo (PDC_WA.xml) DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e id_pdc Cuando status Vacío= 0, date time e ID_PDC Cuando status ERROR=-1, date time e Mensaje de error del sistema 8 EJEMPLOS = 1;20/12/ :00:01; ;20/12/ :00:01;null"

9 Operación: WAU Cambia la solicitud de cotización ya publicada, en análisis o Confirmado Cambia la solicitud de la cotización ya publicado, en análisis o confirmado. El layout XML a ser despachado es igual al de la solicitud (WA). Los cambios posibles tienen las seguintes reglas: PDC ya publicado = En este momento del proceso es posible hacer el cambio de la fecha de cierre, para una fecha mayor o menos que la fecha y hora actuales. Cambio de la fecha de cierre tiene que ser mayor que la fecha y hora actuales de actualización (data cierre > sysdate). PDC en análisis = En este momento del proceso es posible hacer el cambio de la fecha de cierre del solicitud, para una fecha mayor o menos de la fecha y horario actuales, cantidad del artículo y programación de entrega. El cambio de cierre tiene que ser mayor que la fecha y horario actuales del actualización (fecha de cierre > sysdate). El cambio de la cantidad siempre debe ser igual al total programado (total programado = cantidad). Para cambio de la programación de entrega, siempre debe ser respetada, así que el total programado sea igual a cantidad (cantidad = total programado). PDC Confirmado = En este momento del proceso es posible cancelar un artículo o cambiar la programación de entrega. Para cancelar un artículo, la cantidad del mismo, debe ser despachada con CERO. Así, la plataforma vá interpretar el cancelamento total del artículo. Para cambio de programación de entrega, se requiere el cambio de cantidad total, cuando es hecho el cambio de la cantidad programada. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: LAYOUT=WA,ID= ;XML LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WA Formato Posible = WA ID Establece cual ID (ID_PDC) generado en Bionexo será cambiado., pues la información es despachada (se requiere) en archivo. Formato = Numérico. 9 XML Datos generados según el esquema WA.

10 Formato = Despachado por separado schema (PDC_WA.xsd) y archivo ejemplo (PDC_WA.xml). DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e id_pdc Cuando status Vacío= 0, date time e ID_PDC Cuando status ERROR=-1, date time y Mensaje de error del sistema EJEMPLOS = 1;20/12/ :00:01; ;20/12/ :00:01;null" Operación: WASE Crea solicitud de cotización en espera Creación de solicitud de cotización sin que sea publicado. Las solicitudes quedan aguardando validación del comprador y despacho por la plataforma. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: LAYOUT=WA, ;XML LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WA Formato Posible = WA ID Especifica cual ID (ID_PDC) generado en Bionexo será cambiado., pues la misma información ya esta contenida en archivo (se requiere). Formato = Number. 10 XML Datos generados según el esquema WA.

11 Formato = Despachado por separado schema (PDC_WA.xsd) y archivo del ejemplo (PDC_WA.xml). DEVOLUCIÓN Informaciones que servidor vuelve después del ejecución. MENSAJE = Cuando status OK= 1, date time e id_pdc Cuando status Vacío= 0, date time e ID_PDC Cuando status ERROR=-1, date time y Mensaje de error del sistema EJEMPLOS = 1;20/12/ :00:01; ;20/12/ :00:01;null" Operación: WBS Crea solicitud de compra (artículos cotizados) Después que la solicitud de la cotización fue generada y las respuestas (cotizaciones) hechas, la solicitud de compra debe ser despachada al proveedor por esta operación. Hacer upload/envio de los productos que fueran seleccionados/adjudicados en el sistema servinte. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: LAYOUT=WE;XML LAYOUT Establece el layout que los datos (XML) son enviados. Valor estándar = WB Formato posible = WB ID Especifica cual ID (ID_PDC) generado en Bionexo será confirmado., pues la misma información ya esta contenida en archivo (se requiere). Formato = Number. 11 XML Datos generados según el esquema WB. Formato = Despachado por separado schema (Confirmacao_WB.xsd) y archivo del ejemplo

12 (Confirmacao_WB.xml). DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e id_pdc Cuando status Vacío= 0, date time e ID_PDC Cuando status ERROR=-1, date time e Mensaje de error del sistema EJEMPLOS = 1;20/12/ :00:01; ;20/12/ :00:01;null" Operación: WBSC Crea carrito de compras (Pre-solicitud) Después que la solicitud de cotización fue generada y las respuestas(cotizaciones) hechas, las cotizaciones pueden ser recuperadas para el sistema local y después ser generado la presolicitud en Bionexo que tendrá una evaluación del comprador antes que la solicitud de compra sea confirmada en la plataforma. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: LAYOUT=WB;XML LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WB Formato Posible = WB ID Especifica cual ID (ID_PDC) generado en Bionexo será creado la pre-solicitud. No se requiere, pues la misma información ya está contenida en archivo (se requiere). Formato = Number. 12 XML Datos generados según esquema WB. Formato = Despachado por separado schema (Confirmacao_WB.xsd) y archivo de ejemplo

13 (Confirmacao_WB.xml). DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e id_pdc Cuando status Vacío= 0, date time e ID_PDC Cuando status ERROR=-1, date time e MENSAJE de error del sistema EJEMPLOS = 1;20/12/ :00:01; ;20/12/ :00:01;null" Operación: WCG Recupera Respuestas (Artículos y cotizaciones) Después que la solicitud de cotización fue generada y las respuestas hechas (cotizaciones), se puede vuelver para el sistema local (esta operación ejecuta la tarea). Download de todas respuestas de los provedores. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: LAYOUT=WC;ISO=1;ID= LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WC Formato Posible = WC ID Especifica cual ID (ID_PDC) generado en Bionexo son de las respuestas (cotizaciones) que son bajadas. Formato = Number. 13 ISO Establece el tipo de codificación que los datos (XML) son generados. Valor estándar = ISO = 1 (ISO ). Formatos Posibles = ISO = 0 datos en codificación UTF-8 ISO = 1 datos en codificación ISO

14 DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e id_pdc Cuando status Vacío= 0, date time e ID_PDC Cuando status ERROR=-1, date time e MENSAJE de error del sistema EJEMPLOS = 1;20/12/ :00:01;XML 0;20/12/ :00:01;null" XML: El XML sigue el formato despachado por separado schema (Respostas_WC.xml) y archivo de ejemplo (Respostas_WC.xsd). Operación: WDG Recupera Carrito de Compras (Pre-solicitud) Después que el pedido de cotización fue generado y las respuestas(cotizaciones) hechas, el sistema local podrá bajar el carrito de compras (pre-solicitud), aquí la equivalencia entre proveedores y artículos es de 1x1. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: 14

15 LAYOUT=WD;ISO=1;ID= LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WD Formato Posible = WD ID Establece cual ID (ID_PDC) generado en Bionexo corresponden a las respuestas(cotizaciones) que son bajadas. Formato = Number. ISO Establece el tipo de codificación que los dados (XML) son generados. Valor estándar = ISO = 1 (ISO ). Formatos posibles = ISO = 0 datos em codificación UTF-8 ISO = 1 datos en codificación ISO DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e id_pdc Cuando status Vacío= 0, date time e ID_PDC Cuando status ERROR=-1, date time e MENSAJE de error del sistema EJEMPLOS = 1;20/12/ :00:01;XML 0;20/12/ :00:01;null" XML: El XML sigue el formato despachado por separado schema (Carrinho_WD.xml) y archivo ejemplo (Carrinho_WD.xsd). 15

16 Operación: WEG Recupera Solicitud de Compras Después que la solicitud de cotización fue generada, pueden ser recuperadas las informaciones de la solicitud de compra por esta operación. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: LAYOUT=WE;ISO=1;ID= LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WE Formato Posible = WE 16 ID Especifica cual ID (ID_PDC) generado en Bionexo corresponde a solicitud de compra que será recuperado. Formato = Number.

17 ISO Establece el tipo de codificación que los dados (XML) son generados. Valor estándar = ISO = 1 (ISO ). Formatos Posibles = ISO = 0 datos en codificación UTF-8 ISO = 1 datos en codificación ISO DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e id_pdc Cuando status Vacío= 0, date time e ID_PDC Cuando status ERROR=-1, date time e MENSAJE de error del sistema EJEMPLOS = 1;20/12/ :00:01;XML 0;20/12/ :00:01;null" XML: El XML sigue el formato despachado por separado schema (Confirmados_WE.xml) y archivo ejemplo (Confirmados_WE.xsd). 17 Operación: WIP Catastro / alteración de Productos Esta operación es utilizada para hacer catastro o actualizar artículos ya catastrados. La clave es el código del producto en sistema de gestión. El catastro de producto es hecho basado en las informaciones contenidas en layout XML. Si la clave (código) ya tiene en el catastro, el sistema actualizará las informaciones (no es posible cambiar código, categoría, unidad de medida.

18 Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: LAYOUT=WI;XML LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WI Formato Posible = WI XML Datos generados según esquema WI. Formato = El XML sigue el formato despachado por separado schema (CadastroProduto_WI.xsd) y archivo ejemplo (CadastroProduto_WI.xml). DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e null Cuando status Vacío= 0, date time e null Cuando status ERROR=-1, date time e MENSAJE de error del sistema EJEMPLOS = 1;20/12/ :00:01; 0;20/12/ :00:01;" OBS = Sigue adjunto la normalización de las unidades de medida. La normalización de las categorías siguen descritas en XSD por elemento tipo ENUMERATION. Operación: WMG Recupera Proveedor(es) Esta Operación debe ser utilizada para recuperar proveedores(es) cuando es necesario hacer el catastro do mismo en el sistema de gestión. Separador: Punto y coma (;) 18 Ejemplo de despacho de múltiples parámetros:

19 layout=wm;iso=0;cnpj= , LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WM Formato Posible = WM ISO Establece el tipo de codificación que los datos (XML) son generados. Valor estándar = ISO = 1 (ISO ). Formatos Posibles = ISO = 0 datos en codificación UTF-8 ISO = 1 datos en codificación ISO CNPJ Establece cual proveedor debe vuelver en XML. Formatos Posibles = El formato del CNPJ deber ser según el ejemplo: , DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = Cuando status OK= 1, date time e XML Cuando status Vacío= 0, date time e null Cuando status ERROR=-1, date time e MENSAJE de error del sistema EJEMPLOS = 1;20/12/ :00:01;XML 0;20/12/ :00:01;null" XML: El XML sigue el formato despachado por separado schema (Empresas_WM.xml) y archivo ejemplo (Empresas_WM.xsd). 19

20 Operación: WFG Recupera Contratos Esta operación debe ser utilizada para recuperar los contratos cadastrados en la plataforma. Puede ser llamada sin despachar parámetros, así, todos los contratos cadastrados o cambiados en las ultimas 24 horas. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: layout=wf;iso=0;cnpj= LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WF Formato Posible = WF ISO Establece el tipo de codificación que los datos (XML) son generados. Valor estándar = ISO = 1 (ISO ). Formatos Possíveis = ISO = 0 datos en codificación UTF-8 ISO = 1 datos en codificación ISO CNPJ Establece si los contratos de un proveedor debe vuelver en el archivo XML. Formatos Posibles = El formato del CNPJ (CUIT o NIT), deber ser según el ejemplo: , DT_BEGIN Filtra los contratos que deben vuelver por la fecha de publicación. Formato = DD/MM/YYYY HH:MM:SS DT_END Filtra os contratos que deben vuelver por la fecha de cierre. Formato = DD/MM/YYYY HH:MM:SS DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. 20 MENSAJE = Cuando status OK= 1, date time e XML Cuando status Vacío= 0, date time e null Cuando status ERROR=-1, date time e MENSAJE de error del sistema

21 EJEMPLOS = 1;20/12/ :00:01;XML 0;20/12/ :00:01;null" XML: El XML sigue el formato despachado por separado schema (Contratos_WF.xml) y archivo ejemplo (Contratos_WF.xsd). Operación: WFU Actualización de Contratos Esta operación se debe utilizar para actualizar contrato, con status contratado, con vigencia o no. Sólo los atributos "fecha del término del contrato " y "status del contrato" se pueden cambiar. Para la fecha del término del contrato, solamente se puede cambiar para otro valor igual o mayor que la fecha actual. Por el estado del contrato, permitirá cambios para "A" (lo acepta) o "X" (cancelarlo). Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: layout=wf;iso=0;cnpj= LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WF Formato Posible = WF ISO Establece el tipo de codificación que los datos (XML) son generados. Valor estándar = ISO = 1 (ISO ). Formatos Possíveis = ISO = 0 datos en codificación UTF-8 ISO = 1 datos en codificación ISO DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. MENSAJE = EJEMPLOS = Cuando status OK= 1, date time e XML Cuando status Vacío= 0, date time e null Cuando status ERROR=-1, date time e MENSAJE de error del sistema 1;20/12/ :00:01;XML 0;20/12/ :00:01;null" 21

22 XML: El XML sigue el formato despachado por separado schema (Contratos_WF.xml) y archivo ejemplo (Contratos_WF.xsd). Operación: WOP Registrar Ocurrencia para el proveedor Operación utilizada para registrar una ocurrencia para un proveedor. Separador: Punto y coma (;) Ejemplo de despacho de múltiples parámetros: LAYOUT=WO;XML;ID= LAYOUT Establece el layout que los datos (XML) son despachados. Valor estándar = WO Formato Posible = WO XML Datos generados según esquema WO. Formato = El XML sigue el formato despachado por separado schema (Ocorrencia_WO.xsd) y archivo ejemplo (Ocorrencia_WO.xml). ID Especifica cual ID (ID_PDC) da plataforma Bionexo corresponde a la solicitud de la compra que será grabada la ocurrencia. Formato = Number. CNPJ Establece el proveedor para recibir la ocurrencia que está siendo grabada. ( Formatos Posibles = El formato del CNPJ deber ser según el ejemplo: , DEVOLUCIÓN Informaciones que el servidor vuelve después de la ejecución del método. 22 MENSAJE = Cuando status OK= 1, date time e null Cuando status Vacío= 0, date time e null Cuando status ERROR=-1, date time e MENSAJE de error del sistema

23 23 EJEMPLOS = 1;20/12/ :00:01; 0;20/12/ :00:01;"

24 5 Entornos Homologación: Entorno con acceso limitado solamente utilizado para hacer homologación del desarrollo hecho, con plazo de utilización acordado. Entorno utilizado también para homologar paquetes de desarrollo. El usuario y contraseña para acceder esto entorno es despachado por separado después que los procesos comerciales se cumplen. Colômbia: URL: URL validadora: México: URL: URL validadora: Producción: Entorno con acceso limitado y disponible después de la homologación. Entorno de real de alta disponibilidad. Toda información registrada en esto entorno, eres de total responsabilidad del autor. El usuario y contraseña para acceso es despachado por separado después que los procesos comerciales se cumplen. Colômbia: URL: (SSL): URL validadora (SSL): México: URL: (SSL): URL validadora (SSL): 24