Fuente de datos REST en Jitterbit App Builder

Introducción

La fuente de datos REST te permite conectar App Builder a varios servidores REST (incluyendo otras instancias de App Builder), o para su uso con objetos REST. La configuración de un servidor de fuente de datos REST se utiliza en todos los puntos finales REST.

Configurar una fuente de datos REST implica los siguientes pasos:

1. Crear un servidor de fuente de datos REST.

2. Configurar los encabezados de solicitud.

3. Configurar los parámetros de la cadena de consulta.

4. Crear puntos finales REST para cada método de API que se esté llamando.

5. Agregar puntos finales REST.

6. (Opcional) Sobrescribir los tipos de contenido de solicitud/respuesta del punto final.

7. (Opcional) Configurar la paginación de respuestas.

Desde App Builder 4.45, también puedes crear un punto final REST a partir de un documento OpenAPI.

Crear un servidor de datos REST

Para crear un servidor de datos REST, sigue estos pasos:

1. Selecciona IDE > Servidores de Datos.

2. Haz clic en el botón + Servidor.

3. En la sección Configuración del Servidor, establece los siguientes campos:

   • Nombre del Servidor: Ingresa un nombre para el servidor REST.

   • Tipo: Abre el menú, luego busca y selecciona REST API.

   • Url: Ingresa la URL del servidor al que deseas conectarte.

     Nota

     Los puntos finales se configuran en la siguiente sección.

   • Tipo de Contenido de Solicitud y Tipo de Contenido de Respuesta: Selecciona los tipos de contenido de solicitud y respuesta. (Típicamente, los servidores REST se comunican a través de JSON.)

4. (Opcional) Expande la sección Configuración de Seguridad, luego establece lo siguiente:

   • Proveedor de Seguridad: Abre el menú, luego busca y selecciona el proveedor de seguridad requerido.

   • Nombre de Usuario: Ingresa el nombre de usuario para el servicio del proveedor de seguridad.

   • Contraseña: Ingresa la contraseña para el servicio del proveedor de seguridad.

   Consejo

   La mayoría de las APIs REST utilizan una clave de API en el encabezado (configurada en una sección posterior).

5. (Opcional) Descripción: Ingresa una descripción para este servidor.

6. Haz clic en el botón Guardar, luego cierra el diálogo.

Deberías ver tu Servidor de Datos REST en la lista de Servidores de Datos.

Configurar encabezados de solicitud

La mayoría de los servicios REST requieren que pases una clave API utilizando el encabezado de solicitud.

Para configurar el encabezado de solicitud, sigue estos pasos:

1. Selecciona IDE > Servidores de Datos.

2. Haz clic en el botón Detalles para tu nuevo servidor de datos REST.

3. En el panel de Parámetros del Servicio Web, haz clic en el botón + Parámetro. Aparecerá una nueva fila en el panel. Establece los valores de la siguiente manera:

   • Tipo: Abre el menú y selecciona Encabezado.

   • Nombre: Ingresa el nombre del parámetro del encabezado. (Para los servidores REST de App Builder, la clave API se pasa utilizando "X-API-Key".)

   • Valor: Ingresa el valor del parámetro del encabezado.

   • Tipo de Uso: Abre el menú y selecciona el tipo de uso para este parámetro.

4. Haz clic en el ícono para guardar el parámetro.

Configurar parámetros de cadena de consulta

Si tienes parámetros de cadena de consulta comunes que usar en varios puntos finales, puedes configurarlos con los siguientes pasos:

1. Selecciona IDE > Servidores de Datos.

2. Haz clic en el botón Detalles para tu nuevo servidor de datos REST.

3. En el panel de Parámetros del Servicio Web, haz clic en el botón + Parámetro. Aparecerá una nueva fila en el panel. Establece los valores en la fila de la siguiente manera:

   • Tipo: Consulta

   • Nombre: Ingresa el nombre del parámetro de cadena de consulta.

   • Valor: Ingresa el valor del parámetro de cadena de consulta.

   • Tipo de Uso: Abre el menú y selecciona el tipo de uso para este parámetro.

4. Haz clic en el ícono para guardar el parámetro del servidor web.

Agregar puntos finales REST

Una vez que tu Servidor de Datos REST ha sido configurado, puedes agregar puntos finales de API.

Para agregar un punto final, sigue estos pasos:

1. Selecciona IDE > Servidores de Datos.

2. Haz clic en el botón Detalles para tu nuevo servidor de datos REST.

3. En el panel de Endpoints, haz clic en el botón + Endpoint. Aparece una nueva fila en el panel. Establece los valores en la fila de la siguiente manera:

   • Nombre: Ingresa el nombre del endpoint.

   • Endpoint: Ingresa el endpoint. (Este valor se agrega a la URL del Servidor de Datos REST establecida en una sección anterior.)

   • Método: Selecciona el método HTTP para el endpoint.

4. Haz clic en el ícono para guardar el endpoint.

Override endpoint request/response content types

El valor predeterminado para los tipos de contenido de Solicitud y Respuesta se hereda del tipo de contenido del servidor. Los valores de tipo de contenido disponibles son los siguientes:

• Archivo
• Formulario
• JSON
• Multipart
• Texto Plano
• XML

Para anular los tipos de contenido de solicitud o respuesta del endpoint, sigue estos pasos:

1. En el panel de Endpoints, selecciona Más > Caso Especial. Se abre el diálogo Caso Especial del Endpoint.

2. Haz clic en el botón Editar.

3. En la sección Tipo de Contenido, establece valores para lo siguiente:

   • Solicitud: Abre el menú y selecciona el tipo de contenido de solicitud que anula.

   • Respuesta: Abre el menú y selecciona el tipo de contenido de respuesta que anula.

4. Haz clic en el botón Guardar, luego cierra el diálogo.

5. Para revisar la consulta propuesta, haz clic en el botón Descubrir. Se abre el diálogo Endpoint.

6. En el diálogo Endpoint, haz clic en el botón Descubrir para ejecutar la consulta. Esta acción realiza lo siguiente:

   • Genera parámetros de entrada para cualquier entrada de muestra ingresada.

   • Genera tablas de salida para cualquier dato devuelto por el endpoint.

7. Cierra el diálogo Endpoint.

8. En la sección de Endpoints, haz clic en el botón Probar Conexión, luego haz clic en el botón Continuar para llamar al endpoint. Si se definen parámetros de entrada, se envían sus valores de prueba.

Configure response pagination

Para configurar la paginación de la respuesta, sigue estos pasos:

1. Selecciona IDE > Servidores de Datos.

2. Haz clic en el botón Detalles para tu nuevo servidor de datos REST.

3. En el panel de Parámetros del Servicio Web, haz clic en el botón + Parámetro. Aparece una nueva fila en el panel. Establece los valores en la fila de la siguiente manera:

   • Tipo: Consulta

   • Nombre: Ingresa la cadena esperada por el servicio. (Ejemplos incluyen Limit, _limit.)

   • Valor: Ingresa el número de registros por página.

   • Tipo de Uso: Abre el menú y selecciona Límite de Solicitud.

4. Haz clic en el ícono para guardar el parámetro.

5. Haz clic en el botón + Parámetro. Aparece una nueva fila en el panel. Elige uno de los siguientes métodos de paginación y establece los valores de acuerdo a lo siguiente:

   • Desplazamiento de Solicitud: Haz que el servicio omita un número de registros. Establece los valores en la fila de la siguiente manera:

     • Tipo: Consulta

     • Nombre: Desplazamiento de Solicitud

     • (Opcional) Valor: Ingresa el número de registros a omitir.

     • Tipo de Uso: Abre el menú y selecciona Desplazamiento de Solicitud.

   • Número de Página de Solicitud: Obtén un número de página específico. Establece los valores en la fila de la siguiente manera:

     • Tipo: Consulta

     • Nombre: Número de Página de Solicitud

     • (Opcional) Valor: Ingresa el número de la página a obtener.

     • Tipo de Uso: Abre el menú y selecciona Número de página de solicitud.

   • Token Siguiente: Obtén registros desde un punto específico. Establece los valores en la fila de la siguiente manera:

     • Tipo: Consulta

     • Nombre: Token Siguiente

     • (Opcional) Valor: Ingresa la clave del registro desde el cual comenzar.

     • Tipo de Uso: Abre el menú y selecciona Token Siguiente.

6. Haz clic en el ícono para guardar el parámetro.