Fuente de datos REST en Jitterbit App Builder

Introducción

La fuente de datos REST te permite conectar App Builder a varios servidores REST (incluidas 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:

Crear un servidor de fuente de datos REST.
Configurar encabezados de solicitud.
Configurar el cuerpo de la solicitud.
Configurar parámetros de cadena de consulta.
Crear puntos finales REST para cada método API que se esté llamando.
Agregar puntos finales REST.
(Opcional) Sobrescribir tipos de contenido de solicitud/respuesta de punto final.
(Opcional) Configurar paginación de respuesta.

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:

Selecciona IDE > Servidores de Datos.
Haz clic en el botón + Servidor.
En la sección Configuración del Servidor, establece los siguientes campos:
- Nombre del Servidor: Ingresa un nombre para el servidor REST.
- Tipo: 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.)
(Opcional) Expande la sección Configuración de Seguridad, luego establece lo siguiente:
- Proveedor de Seguridad: 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 API en el encabezado (configurada en la siguiente sección).
(Opcional) Descripción: Ingresa una descripción para este servidor.
Haz clic en el botón Guardar, luego cierra el diálogo. Deberías ver tu nuevo servidor de datos REST en la lista.

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:

Selecciona IDE > Servidores de Datos.
Haz clic en el botón Abrir registro para tu nuevo servidor de datos REST.
En el popup de Servidor, bajo Configuración del Servidor, haz clic en el ícono de Puntos finales .
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: 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: (Opcional) Selecciona el tipo de uso para este parámetro.
Haz clic en el ícono para guardar el parámetro.

Configurar cuerpo de solicitud

Para cambiar cómo se estructura la carga útil al usar métodos POST o PUT, sigue estos pasos:

En el panel de Puntos finales, selecciona Más > Caso Especial. Se abre el diálogo de Caso Especial del Punto Final.
Haz clic en el botón Editar.
En la sección de Solicitud, establece Cuerpo de Solicitud en uno de los siguientes valores:
- Objeto: (Predeterminado) La carga útil se envía como un único objeto JSON. Usa esto al crear o actualizar un solo registro.
  Ejemplo
```
{
  "id": 123,
  "name": "A single record"
}
```
- Array: La carga útil se envía como un arreglo JSON de objetos. Usa esto para enviar un lote de múltiples registros en una sola solicitud.
  Ejemplo
```
[
  { "id": 123, "name": "First record" },
  { "id": 124, "name": "Second record" }
]
```
- Omitir Raíz: Para cargas útiles que están envueltas en un objeto de nivel superior, esta opción ignora el envoltorio y envía el primer elemento hijo como la carga útil. Esto es útil para escenarios de 'drill down'.
  
  Por ejemplo, si el sistema genera una carga útil con un envoltorio data, Skip Root envía solo el contenido dentro de data.
  Ejemplo de Carga Útil Enviada
```
{
  "id": 123,
  "name": "The actual record"
}
```
Haga clic en el botón Guardar, luego cierre el diálogo.

Configurar parámetros de cadena de consulta

Si tiene parámetros de cadena de consulta comunes que utilizar en varios puntos finales, puede configurarlos con los siguientes pasos:

Seleccione IDE > Servidores de Datos.
Haga clic en el botón Abrir registro para su nuevo servidor de datos REST.
En el popup de Servidor, bajo Configuración del Servidor, haga clic en el ícono de Puntos Finales .
En el panel de Parámetros del Servicio Web, haga clic en el botón + Parámetro. Aparece una nueva fila en el panel. Establezca los valores en la fila de la siguiente manera:
- Tipo: Seleccione Consulta.
- Nombre: Ingrese el nombre del parámetro de cadena de consulta.
- Valor: Ingrese el valor del parámetro de cadena de consulta.
- Tipo de Uso: (Opcional) Seleccione el tipo de uso para este parámetro.
Haga clic en el ícono para guardar el parámetro.

Agregar puntos finales REST

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

Para agregar un punto final, siga estos pasos:

Seleccione IDE > Servidores de Datos.
Haga clic en el botón Abrir registro para su nuevo servidor de datos REST.
En el popup de Servidor, bajo Configuración del Servidor, haga clic en el ícono de Puntos Finales .
En el panel de Puntos Finales, haga clic en el botón + Punto Final. Aparece una nueva fila en el panel. Establezca los valores en la fila de la siguiente manera:
- Nombre: Ingrese el nombre del punto final.
- Punto Final: Ingrese el punto final. (Este valor se agrega a la URL del Servidor de Datos REST establecida en una sección anterior.)
- Método: Seleccione el método HTTP para el punto final.
Haz clic en el ícono para guardar el endpoint.

Sobrescribir tipos de contenido de solicitud/respuesta del endpoint

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 sobrescribir los tipos de contenido de solicitud o respuesta del endpoint, sigue estos pasos:

En el panel de Endpoints, selecciona Más > Caso extremo. Se abre el cuadro de diálogo Caso extremo del endpoint.
Haz clic en el botón Editar.
En la sección de Tipo de contenido, establece valores para lo siguiente:
- Solicitud: Selecciona el tipo de contenido de solicitud que sobrescribe.
- Respuesta: Selecciona el tipo de contenido de respuesta que sobrescribe.
Haz clic en el botón Guardar, luego cierra el cuadro de diálogo.
Para revisar la consulta propuesta, haz clic en el botón Descubrir. Se abre el cuadro de diálogo Endpoint.
En el cuadro de 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.
Cierra el cuadro de diálogo Endpoint.
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.

Configurar paginación de respuesta

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

Selecciona IDE > Servidores de datos.
Haz clic en el botón Abrir registro para tu nuevo servidor de datos REST.
En el popup de Servidor, bajo Configuraciones del servidor, haz clic en el ícono de Endpoints .
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 valores en la fila de la siguiente manera:
- Tipo: Selecciona 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 luego selecciona Límite de Solicitud.
Haz clic en el ícono para guardar el parámetro.
Haz clic en el botón + Parámetro. Aparecerá una nueva fila en el panel. Elige uno de los siguientes métodos de paginación y luego establece los valores de la siguiente manera:
- 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 luego 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 luego 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 para el registro desde el cual comenzar.
  - Tipo de Uso: Abre el menú y luego selecciona Token Siguiente.
Haz clic en el ícono para guardar el parámetro.