Configurar una fuente de datos REST
Prerrequisito
- Acceso al menú Configuración > Fuente de datos REST (AD052).
Introducción
El sistema permite configurar fuentes de datos para que SoftExpert Suite pueda conectarse a otros sistemas a través del Web Service REST.
Vea cómo configurar una fuente de datos REST dentro del sistema:
Configurar fuente de datos REST
La fuente de datos REST también puede configurarse para utilizar las API de SoftExpert Suite. Para cada interfaz REST disponible en SoftExpert Suite, es necesario configurar una fuente de datos REST. Por ejemplo: para utilizar la interfaz RIS_RISK_INTERFACE, es necesario crear una fuente de datos REST que será utilizada para realizar la conexión y tendrá los parámetros necesarios para esta interfaz. Si, además de esta interfaz, también se utiliza la interfaz RIS_CONTROL_INTERFACE, se deberá crear otra fuente de datos.
Consulte información adicional sobre cada una de las etapas de registro de la fuente de datos REST:
Datos del servicio REST
Datos del servicio
• El Identificador debe contener letras y puede contener números, pero no puede empezar por números.
• En el campo URL del servicio, se debe introducir la URL de la API REST que se utilizará para realizar la integración. Si el servicio va a utilizar parámetros del tipo PATH, estos deben introducirse en la propia URL (basta con añadir un endpoint, por ejemplo: https://exampleservice.com/user/{path}). Tenga en cuenta que el parámetro PATH que es introducido en la URL será añadido por el sistema en la etapa Parámetro de entrada, que debe tener un valor durante el consumo para que la operación sea realizada con éxito.
• Si se habilita la opción Web Service interno de SoftExpert Suite, será posible seleccionar una API REST interna proporcionada por SoftExpert Suite. Con esto, no será necesario crear una fuente, si se cambia la configuración del dominio del entorno.
• Al configurar una interfaz REST proporcionada por SoftExpert Suite, es posible obtener la URL del servicio en la sección Reference.
Parámetros de entrada
Métodos HTTP disponibles para selección:
GET | Realiza la operación de recuperación de datos del servicio agregado. |
POST | Realiza la operación de envío de datos del servicio agregado. |
PUT | Realiza la operación de actualización de datos del servicio agregado. |
DELETE | Realiza la operación de eliminación de datos del servicio agregado. |
Tipos de parámetros disponibles para selección:
QUERY | Indica que el parámetro será una Query string. |
HEADER | Indica que el parámetro será un Header necesario para la petición. |
PATH | Esta opción no estará disponible para selección. Aparecerá, ya seleccionada, cuando el parámetro listado sea un endpoint en la URL del servicio introducida en la etapa anterior. |
Tipos de datos disponibles para selección:
STRING | El valor del parámetro será del tipo texto. |
NUMERIC | El valor del parámetro será del tipo numérico. |
DECIMAL | El valor del parámetro será del tipo numérico con decimales. |
BOOLEAN | El valor del parámetro será del tipo lógico: true or false. |
DATE | El valor del parámetro será del tipo fecha. Al seleccionar esta opción, aparecerá el campo Máscara de fecha. En él, seleccione el formato de fecha en el que se debe ingresar el valor del parámetro. Vea los ejemplos de uso a continuación. |
Si el método previamente seleccionado es POST o PUT, se mostrará el campo Cuerpo de la petición, en el que se debe añadir un ejemplo para el cuerpo de la petición en formato JSON. El cuerpo de ejemplo será utilizado por SoftExpert Suite para mapear los atributos que serán enviados por la petición.
Vea un ejemplo del cuerpo de la petición que se podrá ingresar en el campo presentado:
{
"id": 1,
"name": "New example name"
}
También es posible enviar ejemplos con tipo de fecha:
{
"id": 10,
"name": "example",
"admission Date": "MM/dd/yyyy"
}
El parámetro de fecha debe estar utilizando el valor de formato correctamente. Vea a continuación algunos ejemplos de formatos de fechas:
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 |
• Al configurar una interfaz REST proporcionada por SoftExpert Suite, se debe seleccionar el método POST. Se puede obtener el cuerpo de la petición en la sección Reference.
Parámetros de salida
• Los ejemplos que se deben indicar en el Cuerpo de la respuesta son similares a los explicados para el Cuerpo de la petición de la etapa Parámetros de entrada.
• Al introducir el cuerpo de la petición/respuesta en las secciones Parámetros de entrada y Parámetros de salida, pueden surgir problemas que impidan pasar a la próxima etapa. Consulte la sección Troubleshooting para ver los posibles problemas y sus soluciones.
• Al configurar una interfaz REST proporcionada por SoftExpert Suite, puede obtener el cuerpo de la respuesta en el documento Guía de integración.
Seguridad
En la etapa Seguridad, es posible definir una lista de seguridad para la fuente de datos REST, restringiendo el acceso solo 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 ver la fuente de datos REST. 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 REST, 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
Tras hacer clic en el botón Prueba de consumo, en la pantalla que se abrirá se deberá rellenar la información según las especificaciones del servicio que se está consumiendo.
Entre los parámetros disponibles en la prueba de consumo, se puede completar las siguientes informaciones:
Ruta (Path) | Parámetros del tipo PATH definidos en la URL del servicio. |
Consulta (Query) | Parámetros del tipo QUERY definidos en la etapa Parámetros de entrada. |
Encabezado (Header) | Parámetros del tipo HEADER definidos en la etapa Parámetros de entrada. |
Cuerpo de la petición (Request body) | Parámetros del cuerpo de la petición utilizado para consumir los servicios. |
Para consumir el servicio, haga clic en el botón Ejecutar en la parte inferior de la pantalla. 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. Consulte la sección Troubleshooting para ver las posibles respuestas y sus significados.
Conclusión
¡Eso es todo! Ahora, usted ya sabe cómo configurar una fuente de datos REST dentro del sistema.