Fuente de datos REST en Jitterbit App Builder

Introducción

La fuente de datos REST le permite conectar App Builder a varios servidores REST (incluidas otras instancias de App Builder) o para usar con objetos REST La configuración de un servidor de origen de datos REST se utiliza en todos los extremos REST.

La configuración de una fuente de datos REST implica los siguientes pasos:

1. Crear un servidor de origen de datos REST.

2. Configurar los encabezados de solicitud.

3. Configurar parámetros de la cadena de consultar.

4. Crear extremos REST para cada método API que se llama.

5. Agregar extremos REST.

6. (Opcional) Anular los tipos de contenido de solicitud/respuesta del extremo

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

Desde App Builder 4.45, también puedes crear un extremo REST desde un documento OpenAPI.

Crear un servidor de datos REST

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

1. Seleccione IDE > Servidores de datos.

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

3. En la sección Configuración del servidor, configure los siguientes campos:

   • Nombre del servidor: Ingrese un nombre para el servidor REST.

   • Tipo: Abra el menú, luego busque y seleccione API REST.

   • Url: Ingrese la URL del servidor al que conectarse.

     Nota

     Los Extremos se configuran en la siguiente sección.

   • Tipo de contenido de la solicitud y Tipo de contenido de la respuesta: Seleccione los tipos de contenido de la solicitud y la respuesta. (Normalmente, los servidores REST se comunican mediante JSON).

4. (Opcional) Expanda la sección Configuración de seguridad y luego configure lo siguiente:

   • Proveedor de seguridad: Abra el menú, luego busque y seleccione el proveedor de seguridad requerido.

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

   • Contraseña: Ingrese 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 una sección posterior).

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

6. Haga clic en el botón Guardar y luego cierre el cuadro de diálogo.

Debería ver su 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 mediante el encabezado de la solicitud.

Para configurar el encabezado de solicitud, siga estos pasos:

1. Seleccione IDE > Servidores de datos.

2. Haga clic en el botón Detalles para su nuevo servidor de datos REST.

3. En el panel Parámetros del servicio web, haga clic en el botón + Parámetro. Aparecerá una nueva fila en el panel. Configure los valores como se indica a continuación:

   • Tipo: Abra el menú, luego seleccione Encabezado.

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

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

   • Tipo de uso: Abra el menú, luego seleccione el tipo de uso para este parámetro.

4. Haga clic en el Icono para guardar el parámetro.

Configurar parámetros de cadena de consultar

Si tiene parámetros de cadena de consultar comunes para usar en los puntos finales, puede configurarlos con los siguientes pasos:

1. Seleccione IDE > Servidores de datos.

2. Haga clic en el botón Detalles para su nuevo servidor de datos REST.

3. En el panel Parámetros del servicio web, haga clic en el botón + Parámetro. Aparecerá una nueva fila en el panel. Configure los valores en la fila como se indica a continuación:

   • Tipo: Consulta

   • Nombre: Ingrese el nombre del parámetro de la cadena de consultar.

   • Valor: Ingrese el valor del parámetro de la cadena de consultar.

   • Tipo de uso: Abra el menú, luego seleccione el tipo de uso para este parámetro.

4. Haga clic en el Icono para guardar el parámetro del servidor web.

Agregar extremos REST

Una vez configurado su servidor de datos REST, puede agregar extremos de API.

Para agregar un extremo, siga estos pasos:

1. Seleccione IDE > Servidores de datos.

2. Haga clic en el botón Detalles para su nuevo servidor de datos REST.

3. En el panel Extremos, haga clic en el botón + Extremo. Aparecerá una nueva fila en el panel. Configure los valores en la fila como se indica a continuación:

   • Nombre: Ingrese el nombre del extremo.

   • Extremo: Ingrese el extremo. (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 extremo.

4. Haga clic en el Icono para guardar el extremo.

Anular los tipos de contenido de solicitud/respuesta del extremo

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
• Multiparte
• Texto sin formato
• XML

Para anular los tipos de contenido de solicitud o respuesta del extremo, siga estos pasos:

1. En el panel Extremos, seleccione Más > Caso límite. Se abre el cuadro de diálogo Caso límite de Extremo.

2. Haga clic en el botón Editar.

3. En la sección Tipo de contenido, establezca valores para lo siguiente:

   • Solicitud: Abra el menú y seleccione el tipo de contenido de la solicitud principal.

   • Respuesta: Abra el menú y seleccione el tipo de contenido de respuesta que desea anular.

4. Haga clic en el botón Guardar y luego cierre el cuadro de diálogo.

5. Para revisar la consultar propuesta, haga clic en el botón Descubrir. Se abrirá el cuadro de diálogo Extremo.

6. En el cuadro de diálogo Extremo, haga clic en el botón Descubrir para ejecutar la consultar. 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 extremo.

7. Cierre el cuadro de diálogo Extremo.

8. En la sección Extremos, haga clic en el botón Probar conexión y, a continuación, en el botón Continuar para llamar al extremo. Si se definen parámetros de entrada, se envían sus valores de prueba.

Configurar la paginación de respuestas

Para configurar la paginación de respuestas, siga estos pasos:

1. Seleccione IDE > Servidores de datos.

2. Haga clic en el botón Detalles para su nuevo servidor de datos REST.

3. En el panel Parámetros del servicio web, haga clic en el botón + Parámetro. Aparecerá una nueva fila en el panel. Establezca los valores en la fila de la siguiente manera:

   • Tipo: Consulta

   • Nombre: Introduzca la cadena que espera el servicio. (Por ejemplo, Limit, _limit.)

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

   • Tipo de uso: Abra el menú y seleccione Límite de solicitud.

4. Haga clic en el icono Icono para guardar el parámetro.

5. Haga clic en el botón + Parámetro. Aparecerá una nueva fila en el panel. Elija uno de los siguientes métodos de paginación y configure los valores correspondientes:

   • Desplazamiento de solicitud: Permite que el servicio omita varios registros. Configure los valores en la fila de la siguiente manera:

     • Tipo: Consulta

     • Nombre: Desplazamiento de solicitud

     • (Opcional) Valor: Introduzca el número de registros que desea omitir.

     • Tipo de uso: Abra el menú y seleccione Solicitar desplazamiento.

   • Solicitar número de página: Obtenga un número de página específico. Establezca los valores en la fila de la siguiente manera:

     • Tipo: Consulta

     • Nombre: Solicitar número de página

     • (Opcional) Valor: Introduzca el número de página que se desea obtener.

     • Tipo de uso: Abra el menú y seleccione Solicitar número de página.

   • Token siguiente: Obtener registros desde un punto específico. Establezca los valores en la fila de la siguiente manera:

     • Tipo: Consulta

     • Nombre: Token siguiente

     • (Opcional) Valor: Introduzca la clave desde la que se iniciará el registro.

     • Tipo de uso: Abra el menú y seleccione Siguiente token.

6. Haga clic en el icono Icono para guardar el parámetro.