Configurar una fuente de datos Web Service
Prerrequisito
- Acceso al menú Configuración > Fuente de datos Web Service (AD053).
Introducción
El sistema proporciona un menú para que los usuarios registren todas las fuentes de datos que conectarán SoftExpert Suite con otros sistemas vía Web Service.
Vea cómo configurar las fuentes de datos Web Service dentro del sistema:
Configurar fuente de datos Web Service
Vea más detalles sobre cada una de las etapas:
Datos del Web Service
• El botón Habilitado permite habilitar o deshabilitar el web service sin necesidad de eliminarlo.
• Marque la opción Web service interna de SE Suite para seleccionar un web service interno proporcionado por SoftExpert Suite. Con eso, no será necesario crear una nueva fuente si las configuraciones de dominio del entorno son modificadas. Los campos Versión del WSDL y URL de conexión no estarán disponibles, ya que estas informaciones serán definidas internamente.
• Ejemplos de formatos de fecha que se pueden utilizar:
Formato | Descripción | Ejemplo |
MM/dd/yyyy | Estándar americano de fecha | 06/22/2024 |
dd/MM/yyyy | Estándar europeo de fecha | 15/03/2024 |
HH:mm:ss | Horas, minutos y segundos | 18:37:05 |
KK:mm:ss a | Horas, minutos y segundos (AM/PM) | 07:44:23 PM |
dd/MM/yyyy HH:mm:ss | Fecha, horas, minutos y segundos | 26/12/2024 12:30:55 |
dd/MM/yyyy KK:mm:ss a | Fecha, horas, minutos y segundos (AM/PM) | 12/07/2024 11:50:02 AM |
EE MMM dd hh:mm:ss Z yyyy | Fecha descriptiva, día, horario (AM/PM), huso horario y año | Mar ago 16 12:00:00 BRT 2024 |
• Tipos de autenticación disponibles para la selección:
Anónimo | No habrá necesidad de autenticación. |
Autenticación básica | La autenticación se realizará por usuario y contraseña en el encabezado de la petición HTTP. En los respectivos campos que serán habilitados, ingrese el Usuario y la Contraseña que se utilizarán para la autenticación del servicio. Si lo desea, informe también el dominio que será utilizado. |
WS-Security (Password Text) | El usuario y la contraseña se envían con el mensaje SOAP para validar la comunicación entre el servicio y su consumidor. En los respectivos campos que serán habilitados, ingrese el Usuario y la Contraseña que se utilizarán para la autenticación del servicio. |
API key |
La autenticación se realizará por token en el encabezado de la petición HTTP. Este tipo de autenticación debe utilizarse solo cuando la fuente de datos registrada sea un WSDL de SoftExpert Suite. En el campo API key que aparecerá, informe el token del usuario que se utilizará para la operación. El token utilizado puede ser generado a través de la sección API Gateway de la pantalla de datos de usuario, cuando se accede a través del panel de usuario. Para más información sobre este tipo de autenticación, consulte la Guía de integración. |
• El campo URL de conexión no estará disponible si se ha marcado la opción Web service interna de SE Suite.
Método
• En la jerarquía de parámetros, es posible identificar el tipo de dato de cada parámetro. Vea los tipos de datos que son admitidos:
TEXT | |
NUMERIC | |
DECIMAL | |
TIME | |
DATE | |
BOOLEAN | |
ESNUM | |
BINARY |
• Especificaciones no admitidas de Web Service:
Tipo de datos Array | Elementos que utilizan el tipo Array (por ejemplo: soap-enc:Array) o array a través de corchetes (por ejemplo: "element[]"). Se recomienda utilizar el atributo maxOccurs="unbounded" para representar arreglos. |
Retornos con estructuras dinámicas | Métodos que tienen retornos con estructuras dinámicas, ya que no sería posible mapear los tipos definidos en el retorno. |
Tipos complejos anidados con tag any | La tag <any> dentro de tags ComplexType anidadas. Se recomienda que cada ComplexType sea declarada de manera independiente, y que todos los elementos contengan el atributo type definido sin la tag <any>. |
Herencia de elementos con la tag Extensión | El uso de la tag <extension> para realizar la herencia entre ComplexTypes. En esta situación, los elementos del ComplexType padre deben replicarse en los hijos para obtener el mismo comportamiento. |
Seguridad
En la etapa Seguridad, es posible definir una lista de seguridad para la fuente de datos Web Service, restringiendo el acceso únicamente a quienes sea necesario.
Consulte las opciones disponibles en la pestaña:
Privado
Solo los usuarios definidos en esta pestaña podrán editar o visualizar la fuente de datos Web Service. Para eso, utilice las siguientes columnas:
- Editar: defina los usuarios, grupos, áreas y/o funciones que podrán editar la fuente de datos.
- Visualizar: defina los usuarios, grupos, áreas y/o funciones que podrán visualizar la fuente de datos.
Público
Todos los usuarios del sistema podrán visualizar la fuente de datos Web Service, sin embargo, solo los usuarios definidos en la respectiva columna podrán editarla. Por lo tanto, la columna Visualizar estará deshabilitada (ya que la fuente de datos puede ser visualizada por cualquier usuario).
En la columna Editar, defina los usuarios, grupos, áreas y/o funciones que podrán modificar los datos de la fuente de datos.
Resumen
En esta etapa, es posible consumir los métodos que se han habilitado. Tras hacer clic en el botón Prueba de consumo, introduzca los valores de los parámetros necesarios para consumir el método y, a continuación, clic en el botón Ejecutar.
Se pueden presentar dos tipos de respuesta:
- Éxito: el consumo se ha realizado correctamente. En este caso, será posible visualizar un JSON que contenga la devolución del servicio a través de SoftExpert Suite.
- Algo salió mal: se ha producido un problema al consumir el servicio. Verifique si este está disponible y si los datos han sido llenados correctamente en las etapas descritas anteriormente.
Conclusión
¡Eso es todo! Ahora, usted ya sabe cómo configurar una fuente de datos Web Service dentro del sistema.