Documentación -...

Documentación

EDI – WebService – Compradores Proyecto: Guía de Integración de Sistemas para el comprador

Preparado para: Bionexo Internacional

Preparado por: Saincler Silva

Fecha Creación: 21 de Julio de 2009

Fecha último cambio: 06 de Março de 2017

Numero del Documento: 20170301

Versión: 2.5

Índice de versiones

Versión Fecha Autor Revisor Descripción

1.0 21/07/2009 Daniel Rocha Daniel Rocha Preparación y traducción de las especificaciones funcionales.

1.1 14/06/2010 Daniel Rocha Daniel Rocha Creación de índice de versión, revisión de los parámetros.

1.2 16/03/2011 Daniel Rocha Daniel Rocha Creación de la operación WIP e revisión de ortografía.

1.3 14/04/2011 Daniel Rocha Daniel Rocha

Creación de la operación WOP, WMG e WFG.

Actualización de la operación WAU.

1.4 01/12/2011 Saincler Silva Daniel Rocha, Diana

Marin Traducción para Español.

1.5 03/11/2015 Carina Nagano Inclusión de la Operación WFU y Url para entornos de prueba Colombia e

México

1.6 17/11/2015 Carina Nagano Inclusión de Flujos WCG, WDG y WEG.

1.7 02/12/2015 Patricia Vicente

Esquaiella

Inclusión y revisión de los tipos, longitud y obligatoriedad de los campos en

archivos Xml

1.8 16/02/2016 Saincler Silva Inclusión del parámetros para operación WFG. DT_BEGIN_SOLICITACAO y

DT_END_SOLICITACAO

1.9 26/02/2016 Luis Alberto

Bonilla Gómez Saincler Silva Ajuste de ortográfica - Método de parámetros de todas las Operaciones.

2.0 27/10/2016 Saincler Silva Saincler Silva Ajustado layout WE,WD,WC para IVA, CUM y Registro Invima

2.1 27/10/2016 Saincler Silva Saincler Silva

Ajustado URL de http para https.

Añadido URL sandbox para Argentina.

2.2 15/02/2017 Carina Nagano Saincler Silva la inclusión de tag en el layout WD, WC e WD. Esta inclusión debe ser un

ajuste en Bionexo junto con el sistema de gestión.

2.3 06/03/2017 Saincler Silva -

la inclusión de tag IVA , Preco_Origem , Marca_Padrao en el layout WI.

Inclusión de observaciones para download automático (sin informar

parámetros) , operaciónes WDG, WEG, WFG.

2.4 12/01/2018 Renan Lima - Añadido URL producción para Argentina.

2.5 16/05/2018 Carina

Nagano - Atualização logo Bionexo

ÍNDICE:

1. Objetivo4

2. Definición4

3. Métodos y Devoluciones5

4. Operaciones y Parámetros8

4.1. Operación: “WAS” – Crea solicitud de cotizacion directa9

4.2. Operación: “WAU” – Cambia la solicitud de cotización ya publicada, en análisis o

Confirmado9

4.3. Operación: “WASE” – Crea solicitud de cotización en espera ...................................... 10

4.4. Operación: “WBS” – Crea solicitud de compra (artículos cotizados)11

4.5. Operación: “WBSC” – Crea carrito de compras (Pre-solicitud)12

4.6. Operación: “WCG” – Recupera Respuestas (Artículos y cotizaciones)13

4.7. Operación: “WDG” – Recupera Carrito de Compras (Pre-solicitud)14

4.8. Operación: “WEG” – Recupera Solicitud de Compras15

4.9. Operación: “WIP” – Catastro / alteración de Productos .............................................. 17

4.10. Operación: “WMG” – Recupera Proveedor(es)18

4.11. Operación: “WFG” – Recupera Contratos19

4.12. Operación: “WFU” – Actualización de Contratos21

4.13. Operación: “WOP” – Registrar Ocurrencia para el proveedor22

5. Entornos24

1 – Objetivo

Definir tecnología utilizada para cambio electrónico de informaciones. Especificar los

métodos utilizados para a comunicación entre los sistemas involucrados e identificar

posibles devoluciones para los métodos utilizados. Describir las posibles operaciones.

Definir entornos para homologación, desarrollo de la tecnología, y determinar el

entorno que será utilizado para integración.

2 – Definición

Tecnología utilizada en esta integración (sistema cliente X Bionexo) es basada en

protocolo SOAP Web Service utilizando los métodos y parámetros llamados pos los

protocolos HTTP (puerto 80) y HTTPS (puerto 443) para la comunicación.

3 – Métodos y Retornos

Sigue abajo la descripción de los métodos y retornos 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 todas las operaciones de envío (POST). Los parámetros deben ser

despachados como el estándar que se describe para HTTP o HTTPS. El archivo XML de

despacho debe estar solo en una string u objeto DataHandler. La devolución y

despacho es hecho por medio de un bloque estándar que varía con la operación y

parámetros despachados que se describe abajo:

Parámetros:

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 informació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;ID_PDC=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:

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.

Mensaje – Varia de acuerdo con la operación llamada, este 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; 20/12/2010 12:00:01;<XML/>”

“0; 20/12/2010 12:00:01;null"

“-1;20/12/2010 12:00:01;Connection is closed”

Errores= “-1 ; 01/01/2010 00:00:00 ; Incorrect login/password”

“-1 ; 01/01/2010 00:00:00 ; Número de acessos por minuto

ultrapassado”

“-1 ; 01/01/2010 00:00:00 ; null – NullPointerException”

“-1 ; 01/01/2010 00:00:00 ; Connection is closed”

“-1 ; 01/01/2010 00:00:00 ; UnsupportedOperationException” (Cuando el parámetro de la operación no fue encontrado)

“-1;15/06/2010 09:19:55;Operation [WDD] not found” (Cuando el parámetro de la operación no fue encontrado)

Flujo: Cambio de datos Server del Cliente.

login

request POST (operation, parameters, xml)

ID

request GET (operation, parameters)

XML

Bio

ne

xo

Sistema de Información

4 – Operaciones y Parámetros

Las operaciones deben ser despachadas en momento de la llamada de los métodos, con una

estructura (string), que valida 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, separados por punto y coma (;).

Abajo se detalla las operaciones posibles y Parámetros válidos, con sus devoluciones:

4.1. Operación: “WAS” – Crea solicitud de cotización directa.

Crea solicitud de cotización publicada, cuando los métodos y parámetros son entregados.

Parámetros:

Separado: Punto y coma (;).

Ejemplo del despacho de múltiples parámetros:

“LAYOUT=WA;XML”

LAYOUT – Determina el layout que será generado (XML).

No se campo obligatorio

Valor estándar = WA

Formato posible = WA

XML – Datos generados según el esquema “WA”.

Campo Obligatorio

Formato = Enviado con la estructura (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.

STATUS = Numero ( >0 = OK , 0 = Vacío o <0 = ERROR )

MENSAJE = Cuando status OK= 1, date time e ID_PDC

Cuando status Vacío= 0, date time Null

Cuando status ERROR=-1, date time e Mensaje de error del sistema

EJEMPLOS = “1;20/12/2010 12:00:01;123456”

“0;20/12/2010 12:00:01;null"


4.2. Operación: “WAU” – Cambia la solicitud de cotización ya

publicada, en análisis o Confirmado.

Cambia la solicitud de la cotización ya publicada, en análisis o confirmado. El layout XML a ser

enviado es igual al de la solicitud (WA). Los cambios posibles tienen las siguientes reglas:

PDC ya publicado = En este momento del proceso es posible hacer el cambio en la fecha y hora

de cierre del PDC, para una fecha mayor o menor que la fecha y hora actuales. Para el cambio

de la fecha de cierre tiene que ser mayor o igual a que la fecha y hora actuales de actualización

(data cierre > sysdate).

PDC en análisis = En este momento del proceso es posible prolongar el cambio de la fecha de

cierre de la solicitud, para una fecha mayor de la fecha y horario actuales, cantidad de artículos

y programación de entregas.

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 enviada

con CERO. Así, la plataforma va interpretar que está cancelando el 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.

Parámetros:

Separado: Punto y coma (;)

Ejemplo de despacho de múltiples parámetros:

“LAYOUT=WA,ID=1234567;XML”

LAYOUT – Establece el layout que los datos (XML) son enviados.

No se requiere


Formato Posible = WA

ID – Establece cual ID (ID_PDC) generado en Bionexo será cambiado.

Valor estándar = No tiene.

Formato = Numérico.


Se requiere




STATUS = Number ( >0 = OK , 0 = Vacío o <0 = ERROR )




EJEMPLOS = “1;20/12/2010 12:00:01;123456”

“0;20/12/2010 12:00:01;null"


4.3. 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.

Parámetros:



“LAYOUT=WA,1234567;XML”

LAYOUT – Establece el layout que los datos (XML) son despachados.

No se requiere


Formato Posible = WA


Se requiere



DEVOLUCIÓN – Informaciones que servidor vuelve después del ejecución.





EJEMPLOS = “1;20/12/2010 12:00:01;123456”

“0;20/12/2010 12:00:01;null"


4.4. Operación: “WBS” – Confirma los productos para proveedores

(artículos cotizados).

Después que la solicitud de la cotización fue generada y los proveedores respondieron la

solicitud de cotización, esta debe ser enviada al proveedor por esta operación. Hacer

upload/envio de los productos que fueran seleccionados/adjudicados en el sistema de

información (ERP).

Parámetros:



“LAYOUT=WE;XML”

LAYOUT – Establece el layout que los datos (XML) son enviados.

No se requiere

Valor estándar = WB

Formato posible = WB

ID – Especifica cual ID (ID_PDC) generado en Bionexo será confirmado.

Si se requiere


Formato = Number.

XML – Datos generados según el esquema “WB”.

Se requiere


Formato = Enviado con la estructura (Confirmación _WB.xsd) y archivo de ejemplo

(Confirmación_WB.xml)

DEVOLUCIÓN – Informaciones que servidor vuelve después del ejecución.

STATUS = Numero (>0 = OK, 0 = Vacío o <0 = ERROR)




EJEMPLOS = “1;20/12/2010 12:00:01;123456”

“0;20/12/2010 12:00:01;null"

4.5. Operación: “WBSC” – Crea carrito de compras (Pre-solicitud).

Después de bajar todas las respuestas de los proveedores al sistema local (ERP), se puede crear

un carrito de compras en Bionexo, que tendrá una evaluación del comprador antes que la

solicitud de compra sea confirmada en la plataforma.

Parámetros:



“LAYOUT=WB;XML”


No se requiere

Valor estándar = WB

Formato Posible = WB

ID – Especifica cual ID (ID_PDC) generado en Bionexo será creada la pre-solicitud.

Si se requiere


Formato = Numero.

XML – Datos generados según esquema “WB”.

Se requiere


Formato = Enviado con la estructura (Confirmación_WB.xsd) y archivo de ejemplo

(Confirmación_WB.xml).




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/2010 12:00:01;123456”

“0;20/12/2010 12:00:01;null"


4.6. Operación: “WCG” – Bajar Respuestas (Artículos y cotizaciones).

Después que los proveedores cotizaron y solicitud de cotización fue cerrada, se puede bajar

para el sistema local, o sea descargar todas respuestas de los proveedores.

Parámetros:



“LAYOUT=WC;ISO=1;ID=1234567”


No se requiere

Valor estándar = WC

Formato Posible = WC

ID – Especifica cual ID (ID_PDC) generado en Bionexo son de las respuestas (cotizaciones) que

son bajadas.

Se requiere


Formato = Numero.

ISO – Establece el tipo de codificación que los datos (XML) son generados.

No se requiere

Valor estándar = ISO = 1 (ISO-8859-1).

Formatos Posibles = ISO = 0 datos en codificación UTF-8

ISO = 1 datos en codificación ISO-8859-1






EJEMPLOS = “1;20/12/2010 12:00:01;XML”

“0;20/12/2010 12:00:01;null"


XML: El formato bajado es (Respuestas_WC.xml) y archivo de ejemplo (Respuestas_WC.xsd).

4.7. Operación: “WDG” – Recupera Carrito de Compras (Pre-solicitud).

Después que los proveedores cotizaron y solicitud de cotización fue cerrada, el sistema de

información (ERP) podrá bajar el carrito de compras (pre-solicitud), aquí la equivalencia entre

proveedores y artículos es de 1x1.

Parámetros:



“LAYOUT=WD;ISO=1;ID=1234567”


No se requiere

Valor estándar = WD

Formato Posible = WD

ID – Establece cual ID (ID_PDC) generado en Bionexo corresponden a las

respuestas(cotizaciones) que son bajadas.

Se requiere


Formato = Numero.

Observacion: Cuando el parametro ID es suprimido, el XML que vuelve es lo que está en la cola para bajar. Esa cola se “alimenta” cuando el comprador añade un carito de compra y lo indica para hacer download automático.

ISO – Establece el tipo de codificación que los dados (XML) son generados.

No se requiere


Formatos posibles = ISO = 0 datos en codificación UTF-8







EJEMPLOS = “1;20/12/2010 12:00:01;XML”

“0;20/12/2010 12:00:01;null"


XML: El formato enviado es (Carrito_WD.xml) y archivo ejemplo (Carrito_WD.xsd).

4.8. Operación: “WEG” – Recupera Solicitud de Compras.

Después que el comprador realizo las confirmaciones por Bionexo, estas se pueden bajar al

sistema de información (ERP).

Parámetros:



“LAYOUT=WE;ISO=1;ID=1234567”

LAYOUT – Establece el layout que los datos (XML) son despachados. No se requiere Valor estándar = WE Formato Posible = WE ID – Especifica cual ID (ID_PDC) generado en Bionexo corresponde a solicitud de compra que será descargada. Se requiere Valor estándar = No tiene. Formato = Numero. Observacion: Cuando el parametro ID es suprimido, el XML que vuelve es lo que está en la cola para bajar. Esa cola se “alimenta” cuando el comprador añade un carito de compra y lo indica para hacer download automático.

ISO – Establece el tipo de codificación de dados (XML) son generados.

No se requiere









EJEMPLOS = “1;20/12/2010 12:00:01;XML”

“0;20/12/2010 12:00:01;null"


XML: El formato enviado es (Confirmados_WE.xml) y archivo ejemplo (Confirmados_WE.xsd).

4.9. Operación: “WIP” – Creación / Modificación de Productos.

Esta operación es utilizada para la creación o actualización de productos.

La llave principal en Bionexo es el código del producto. Si el código del producto ya está creado

la información se actualizará (Categoría, unidad de medida, Marca y Descripción), si no existe

este se creara en Bionexo, no es posible cambiar el código del producto.

Parámetros:



“LAYOUT=WI;XML”


No se requiere

Valor estándar = WI

Formato Posible = WI

XML – Datos generados según esquema “WI”.

Se requiere


Formato = El XML sigue el formato enviado (CreaciónProduto_WI.xsd) y archivo ejemplo

(CreaciónProduto_WI.xml).



MENSAJE = Cuando status OK= 1, date time, cero

Cuando status Vacío= 0, date time e null


EJEMPLOS = “1;26/02/2016 12:07:26;0”

“0;20/12/2010 12:00:01;0"


OBS = Sigue adjunto la normalización de las unidades de medida. La normalización de las

categorías sigue descritas en XSD por elemento tipo NUMERACIÓN.

4.10. Operación: “WMG” – Recupera Proveedor(es).

Esta Operación debe ser utilizada para bajar los datos del proveedor(es), cuando es necesario

realizar la creación o modificación de los datos principales del proveedor(es) en el sistema de

gestión (ERP).

Parámetros:


Ejemplo de envió de múltiples parámetros:

“layout=WM;ISO=0;CNPJ=9999999999-9, 101010100-1”


No se requiere

Valor estándar = WM

Formato Posible = WM


No se requiere




CNPJ – Establece cual proveedor bajar en el XML.

Se requiere


Formatos Posibles = El formato del CNPJ deber ser según el ejemplo:

9999999999-9, 101010100-1.



MENSAJE = Cuando status OK= 1, date time e XML



EJEMPLOS = “1;20/12/2010 12:00:01;XML”

“0;20/12/2010 12:00:01;null"


XML: El formato enviado es (Empresas_WM.xml) y archivo ejemplo (Empresas_WM.xsd).

4.11. Operación: “WFG” – Bajar Contratos.

Esta operación debe ser utilizada para bajar los contratos creados en la plataforma,

indicándole un rango de fecha (Fecha Inicio – Fecha Fin), los contratos creados o cambiados en

las últimas 24 horas pueden ser descargados, sin colocar ningún parámetro (download

automático), si queremos bajar puntualmente un contrato tenemos que colocar el parámetro

Id (Numero de Contrato).

Parámetros:



“layout=WF;ISO=0;CNPJ=9999999999-9” El campo CNPJ corresponde al NIT del proveedor.


No se requiere

Valor estándar = WF

Formato Posible = WF


No se requiere




CNPJ (NIT) – Establece si los contratos de un proveedor debe bajar en el archivo XML.

Se requiere


Formatos Posibles = El formato del CNPJ (CUIT o NIT), deber ser según el ejemplo:

9999999999-9, 101010100-1.

DT_BEGIN – Filtra los contratos que deben bajar por la fecha de publicación.

No se requiere


Formato = DD/MM/YYYY HH:MM:SS

DT_END – Filtra los contratos que deben bajar por la fecha de cierre.

No se requiere


Formato = DD/MM/YYYY HH:MM:SS

ID

DT_BEGIN_SOLICITACAO

DT_END_SOLICITACAO

Descripción: Descarga el contrato por ID. Para bajar todos los contratos creados o

cambiados en la fecha más reciente (24hrs), es necesario informar ID=0. En

esta condición, los contratos CANCELADOS también volverán en el XML si

dentro de las 24hs.

Obligatorio: No Valor Estándar: No tiene Posible valor: Mayor o igual a cero Formato: Numero

Descripción: Descarga los contratos por la fecha inicial que fue solicitado. Obligatorio: No Valor Default: - Posible valor: Fecha Fecha Formato: DD/MM/YYYY HH:MM:SS

Descripción: Descarga los contratos por la fecha final que fue solicitado. Obligatorio: No Valor Default: - Posible valor: Fecha Fecha Formato: DD/MM/YYYY HH:MM:SS

TIPO






EJEMPLOS = “1;20/12/2010 12:00:01;XML”

“0;20/12/2010 12:00:01;null"


XML: El formato enviado es (Contratos_WF.xml) y archivo ejemplo (Contratos_WF.xsd).

4.12. Operación: “WFU” – Actualización de Contratos.

Esta operación se debe utilizar para realizar la actualización del contrato, con status contratado (A), con o sin vigencia. 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).

Parámetros:



Descripcion: Descarga los contratos por el status Obligatorio: No Valor Estándar: - Posible Valor:

C -> Aceptado por el Proveedor/Confirmado X -> Cancelado A -> Contratado P -> Pendente R -> Recusado

Formato: String

“layout=WF;ISO=0;CNPJ=9999999999-9”


No se requiere

Valor estándar = WF

Formato Posible = WF


No se requiere





STATUS = Numero ( >0 = OK , =0 = Vacío o <0 = ERROR )




EJEMPLOS = “1;20/12/2010 12:00:01;XML”

“0;20/12/2010 12:00:01;null"


XML: El XML sigue el formato despachado por separado schema (Contratos_WF.xml) y archivo

ejemplo (Contratos_WF.xsd).

4.13. Operación: “WOP” – Registrar Ocurrencia para el proveedor.

Operación utilizada para registrar una ocurrencia para un proveedor.

Parámetros:



“LAYOUT=WO;XML;ID=123456”


No se requiere

Valor estándar = WO

Formato Posible = WO

XML – Datos generados según esquema “WO”.

Se requiere


Formato = El formato enviado es (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.

No se requiere


Formato = Numero.

CNPJ (NIT) – Establece el proveedor para recibir la ocurrencia que está siendo grabada. (

Se requiere


Formatos Posibles = El formato del CNPJ deber ser según el ejemplo:

9999999999-9, 101010100-1.



MENSAJE = Cuando status OK= 1, date time e null



EJEMPLOS = “1;20/12/2010 12:00:01;”

“0;20/12/2010 12:00:01;"


5 – Entornos

Pruebas: Utilizado para hacer pruebas, entorno utilizado también para homologar paquetes de

desarrollo. Debe solicitar el usuario y contraseña para acceder a este entorno al área de

tecnología de Bionexo, esta información es envida por separado.

Colombia:

URL:

WSDL:

México:

URL: https://sandbox.ws.bionexo.com.mx/BionexoBean

WSDL:

Argentina:

URL:

WSDL:

Producción: Disponible después de la homologación. Entorno de real de alta disponibilidad.

Toda información registrada en esto entorno, es de total responsabilidad del autor. El usuario

y contraseña para acceso tienen que ser solicitados al área de tecnología de Bionexo, esta

información es enviada por separado.

Argentina:

URL: (SSL): https://ws.bionexo.com.ar/BionexoBean

WSDL (SSL): https://ws.bionexo.com.ar/BionexoBean?wsdl

Colombia:

URL: (SSL): https://www.bionexo.com.co/ws2/BionexoBean

WSDL (SSL): https://www.bionexo.com.co/ws2/BionexoBean?wsdl

México:

URL: (SSL): https://ws.bionexo.com.mx/BionexoBean

WSDL (SSL): https://ws.bionexo.com.mx/BionexoBean?wsdl

Documentación -...

Documents

Transcript of Documentación -...