Publicar la aplicación Jitterbit App Builder como un punto final de API REST

Introducción

En App Builder, se puede configurar un servidor de datos para que sea una API, de modo que los datos de la aplicación se puedan acceder a través de una clave de API. Esta función permite crear una clave de API y puntos finales en las aplicaciones. Esta guía mostrará un ejemplo utilizando datos de Northwinds y utiliza una clave de API para conectarse a un punto final creado en una aplicación seleccionada.

Cómo publicar una aplicación de App Builder como un punto final de API REST

1. Configurar una clave de API del proveedor de seguridad

Para configurar una clave de API del proveedor de seguridad que proporcione autenticación para acceder a los puntos finales, sigue estos pasos:

1. Selecciona IDE > Proveedores de Seguridad.

2. Haz clic en + Autenticación de Usuario desde el panel de Autenticación de Usuario.

3. Asigna al proveedor un Nombre. Por ejemplo: Clave de API.

4. Selecciona Clave de API como el valor de Tipo.

5. Marca para seleccionar Habilitado.

6. Haz clic en Guardar.

Dependiendo de tu caso de uso, puedes configurar las siguientes propiedades:

1. Si deseas escribir la API en la barra de ubicación de tu navegador para pruebas (no muy seguro), entonces:

   1. Haz clic en + Propiedad desde el panel de Propiedades.

   2. Selecciona AllowApiKeyInQueryString como el Parámetro.

   3. Ingresa True como el Valor.

   4. Haz clic en la marca de verificación para guardar el registro.

2. Si estás utilizando HTTP (no recomendado), agrega lo siguiente:

   1. Haz clic en Crear.

   2. Selecciona AllowInsecureHttp como el Parámetro.

   3. Ingresa True para el Valor.

   4. Haz clic en la marca de verificación para guardar el registro.

2. Configurar un punto final

Para configurar un endpoint para acceder a la fuente de datos de una aplicación, sigue estos pasos:

1. Selecciona IDE > REST APIs.

2. Haz clic en el botón Manage Endpoints desde el panel de Aplicación.

3. Selecciona la aplicación donde deseas configurar el Endpoint. Por ejemplo: Northwinds Design.

4. Haz clic en el ícono de edición para la aplicación.

5. Ingresa el valor del Endpoint en el campo Endpoint. Por ejemplo: northwinds.

6. Haz clic en el botón Proceed, luego cierra el popup.

3. Publicar un endpoint

Para publicar el endpoint creado en el paso anterior:

1. Selecciona IDE > REST APIs.

2. Haz clic en el ícono Doc para la API para ver la información necesaria más adelante para conectarte a este Endpoint.

3. Haz clic en + Resource desde el panel de Resources. Se abre el popup de Recursos.

4. Selecciona una Tabla para establecer un valor para el Endpoint.

5. Haz clic en Save, luego cierra el popup.

6. En el panel de Resources, haz clic en el ícono Structure para controlar qué campos están disponibles en la API.

   • Desmarca Include By Default y/o elimina el(los) campo(s) por completo para limitar el acceso a través de la conexión API, luego cierra el popup.

7. Desde el panel de Resources, haz clic en el ícono Open Record para expandir y ver el popup de Resource.

   1. El Name del recurso debe ser añadido a la URL Base y al Endpoint del Documento API para recuperar esta información.

   2. Establece Default Get Limit o Get Max Limit. Estos valores controlan la cantidad de registros devueltos en las llamadas GET a tu endpoint API.

   3. (Opcional, desde App Builder 4.51.) Abre el menú Compatibility, luego selecciona una de las siguientes opciones:

      • Version 1: Usa el comportamiento REST original—los eventos Insert no son precedidos por eventos New. (Predeterminado para endpoints creados con App Builder 4.50 y versiones anteriores.)

      • Version 2: Usa un comportamiento REST mejorado—los eventos New y cualquier regla predeterminada se invocan antes de los eventos Insert. (Predeterminado para endpoints creados con App Builder 4.51.)

      • Versión 3: (Desde App Builder 4.52.) Igual que la versión 2, pero las API devuelven el valor lógico en lugar del valor de almacenamiento. Por ejemplo, los valores booleanos se devuelven como true o false en lugar de 1 o 0. (Predeterminado para los puntos finales creados con App Builder 4.52 y versiones posteriores.)

   4. Cierra el popup de Recurso.

4. Configurar claves API para usuarios

Para configurar claves API para usuarios específicos:

1. Navega a IDE > Gestión de Usuarios.

2. Selecciona un usuario existente o crea un nuevo usuario para usar en la llamada a la API.

   • El usuario debe estar configurado con el Tipo de Inicio de Sesión Interactivo.

   • El usuario no necesita tener Autenticación Local.

3. En el registro del usuario seleccionado/creado, haz clic en el ícono de Claves.

4. Haz clic en Crear y selecciona la clave API creada en el primer paso como el Proveedor.

5. Haz clic en Guardar.

6. La clave generada es lo que el usuario utilizará para acceder a la API publicada.

Para probar o configurar el uso de tus nuevos puntos finales de API, utiliza la Clave API del paso anterior, la URL Base y la información de Punto Final del documento de API, y el Nombre de los detalles del recurso.