Ejemplos de uso de las fuentes de datos REST
Prerrequisito
- Acceso al menú Gestión de fuentes de datos > Fuente de datos > REST (DI001).
Introducción
Este artículo presenta ejemplos de las fuentes de datos REST.
Los ejemplos descritos en esta sección contienen datos reales y pueden aplicarse a cualquier instancia SoftExpert Suite. De esta forma, siguiéndolos, podrá registrar y consumir datos de fuentes REST de ejemplo.
En esta sección, están disponibles también los datos de los servicios utilizados en los registros.
Registro de servicio con autenticación OAuth Client Credentials
1. Acceda al menú Gestión de fuentes de datos > Fuente de datos > REST (DI001).
2. Haga clic en el botón 
.
3. En la etapa Datos del servicio REST del asistente que se abrirá, llene los siguientes campos, como se describe en la tabla a continuación:
| Identificador | sesuiteSampleOAuthService |
| Nombre | SoftExpert Suite OAuth Service Sample |
| URL del servicio | https://<my-domain>/softexpert/rest/sample/oauth |
| Credencial |
Tipo de autenticación: Autenticación OAuth (Client Credentials) URL de acceso al token: https://<my-domain>/softexpert/rest/sample/oauth/token Client ID: idsample Client Secret: somesecret |
El fragmento de las URL que contiene <my-domain> debe cambiarse al dominio del entorno en que se está creando la fuente.
4. Haga clic en el botón Siguiente al fin de la configuración de cada etapa.
5. En la etapa Parámetros de entrada, llene solo el método como GET.
6. En la etapa Parámetros de salida, incluya el cuerpo de la respuesta, según el ejemplo a continuación:
{
"message": "string",
"status": 0
}7. Avance a la etapa Seguridad, sin realizar ninguna configuración en ella.
8. En la etapa Resumen, puede verificar las configuraciones efectuadas en las etapas anteriores. Haga clic en el botón Prueba de consumo para probar el servicio registrado. En la pantalla que se abrirá, haga clic en el botón Ejecutar.
9. ¡Su fuente de datos está debidamente configurada y funcionando correctamente! Haga clic en el botón Finalizar para concluir su registro.
Registro de servicio con método GET
1. Acceda al menú Gestión de fuentes de datos > Fuente de datos > REST (DI001).
2. Haga clic en el botón .
3. En la etapa Datos del servicio REST del asistente que se abrirá, llene los siguientes campos, como se describe en la tabla a continuación:
| Identificador | sesuiteSampleCompanyServiceQuery |
| Nombre | SoftExpert Suite Company Service Query Sample |
| URL del servicio | https://<my-domain>/softexpert/rest/sample/company |
El fragmento de las URL que contiene <my-domain> debe cambiarse el dominio del entorno en que se está creando la fuente.
4. Haga clic en el botón Siguiente al fin de la configuración de cada etapa.
5. En la etapa Parámetros de entrada, llene los campos con los siguientes valores:
- Método: GET
- Identificador: term
- Parámetro: QUERY
- Tipo: STRING
6. En la etapa Parámetros de salida, incluya el cuerpo de la respuesta, según el ejemplo a continuación:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]7. Avance a la etapa Seguridad, sin realizar ninguna configuración en ella.
8. En la etapa Resumen, puede verificar las configuraciones efectuadas en las etapas anteriores. Haga clic en el botón Prueba de consumo para probar el servicio registrado. En la sección Consulta de la pantalla que se abrirá, ingrese el siguiente parámetro:
- term: canada
9. Haga clic en el botón Ejecutar.
10. ¡Su fuente de datos está debidamente configurada y funcionando correctamente! Haga clic en el botón Finalizar para concluir su registro.
Registro de servicio con método POST
1. Acceda al menú Gestión de fuentes de datos > Fuente de datos > REST (DI001).
2. Haga clic en el botón .
3. En la etapa Datos del servicio REST del asistente que se abrirá, llene los siguientes campos, como se describe en la tabla a continuación:
| Identificador | sesuiteSampleCompanyServiceInsert |
| Nombre | SoftExpert Suite Company Service Insert Sample |
| URL del servicio | https://<my-domain>/softexpert/rest/sample/company |
El fragmento de las URL que contiene <my-domain> debe cambiarse al dominio del entorno en que se está creando la fuente.
4. Haga clic en el botón Siguiente al fin de la configuración de cada etapa.
5. En la etapa Parámetros de entrada, llene los campos con los siguientes valores:
- Método: POST
- Cuerpo de la petición:
{
"companyName": "string",
"state": "string",
"country": "string"
}6. En la etapa Parámetros de salida, incluya el cuerpo de la respuesta, según el ejemplo a continuación:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]7. Avance a la etapa Seguridad, sin realizar ninguna configuración en ella.
8. En la etapa Resumen, puede verificar las configuraciones efectuadas en las etapas anteriores. Haga clic en el botón Prueba de consumo para probar el servicio registrado. En la sección Cuerpo de la petición de la pantalla que se abrirá, llene los siguientes parámetros:
- companyName: CT - COMPANY FOR TESTS
- state: SHANDONG
- country: CHINA
9. Haga clic en el botón Ejecutar.
10. ¡Su fuente de datos está debidamente configurada y funcionando correctamente! Haga clic en el botón Finalizar para concluir su registro.
Datos del servicio de ejemplo
El servicio Company simula la manipulación de información sobre datos de corporaciones ficticias y está disponible para ser utilizado en la fuente de datos REST.
Vea a continuación los endpoints disponibles:
Recuperar todas las corporaciones
- URL: https://<my-domain>/softexpert/rest/sample/company
- Método: GET
- Cuerpo de la respuesta:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]
Filtrar corporaciones
- URL: https://<my-domain>/softexpert/rest/sample/company/query
- Método: GET
- Parámetros (Query Params): NOMBRE: term / TIPO: texto
- Cuerpo de la respuesta:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]
Filtrar corporaciones con rango de valor
- URL: https://<my-domain>/softexpert/rest/sample/company/between
- Método: GET
-
Parámetros (Query Params):
◦ NOMBRE: minID / TIPO: numérico
◦ NOMBRE: maxID / TIPO: numérico - Cuerpo de la respuesta:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]
Insertar nueva corporación
- URL: https://<my-domain>/softexpert/rest/sample/company
- Método: POST
- Cuerpo de la petición:
{
"companyName": "string",
"state": "string",
"country": "string"
}- Cuerpo de la respuesta:
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}La corporación insertada no será realmente persistida, ni guardada en memoria, siendo solo un ejemplo que simula la inserción de un registro.
Actualizar corporación
- URL: https://<my-domain>/softexpert/rest/sample/company
- Método: PUT
- Cuerpo de la petición:
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}- Cuerpo de la respuesta:
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}La corporación ingresada no será realmente actualizada, siendo solo un ejemplo que simula la actualización de un registro. Si no se pasa un identificador válido, nada será retornado.
Quitar corporación
- URL: https://<my-domain>/softexpert/rest/sample/company
- Método: DELETE
- Cuerpo de la respuesta:
{
"message": "string"
}La corporación ingresada no será realmente eliminada, siendo solo un ejemplo que simula la eliminación de un registro.
El fragmento de las URL que contiene <my-domain> debe cambiarse al dominio del entorno en que se está creando la fuente.
Conclusión
¡Eso es todo! Ahora usted conoce un ejemplo de registro de fuente de datos con métodos GET y POST y de servicios que se podrán consumir con éxito.