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

Descripción general

En App Builder, puedes configurar un servidor de App Builder 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 te permite crear una clave de API y endpoints en las aplicaciones. Esta guía mostrará un ejemplo utilizando datos de Northwinds y utiliza una clave de API para conectarse a un endpoint creado en una aplicación seleccionada.

Cómo publicar la aplicación de App Builder como un endpoint de API REST

Primero necesitarás configurar una clave de API del proveedor de seguridad para proporcionar autenticación para acceder a los endpoints:

1. Navega a IDE > Security Providers
2. Haz clic en + User Authentication en el panel de Autenticación de Usuarios
3. Asigna al proveedor un Nombre. Por ejemplo: Clave de API
4. Selecciona API Key como el valor de Tipo
5. Marca para seleccionar Enabled
6. Haz clic en Save

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 + Property en el panel de Propiedades
   2. Selecciona AllowApiKeyInQueryString como el Parámetro
   3. Ingresa True como el Valor
   4. Haz clic en el checkmark para guardar el registro
2. Si estás utilizando HTTP, configuración no recomendada, entonces necesitas agregar lo siguiente:
   1. Haz clic en Create
   2. Selecciona AllowInsecureHttp como el Parámetro
   3. Ingresa True para el Valor
   4. Haz clic en el checkmark para guardar el registro

A continuación, necesitarás configurar un endpoint para acceder a la fuente de datos de las aplicaciones:

1. Navega a IDE > REST APIs
2. Haz clic en el botón Manage Endpoints en el panel de Aplicación
3. Selecciona la aplicación donde deseas configurar el Endpoint. Por ejemplo: Diseño de Northwinds
4. Haz clic en el ícono de edición pencil 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

A continuación, publicarás el Endpoint que creaste en el paso anterior:

1. Navega a IDE > REST APIs
2. Haz clic en el ícono de Doc para la API y ver la información que necesitarás más adelante para conectarte a este Endpoint
3. Haz clic en + Objeto de Negocio en el panel de Objetos de Negocio y selecciona una Tabla para establecer un valor para el Endpoint. Por ejemplo: Categoría (Fuente)
4. Haz clic en el ícono de marca de verificación para guardar el registro
5. Haz clic en el ícono de Estructura para controlar qué campos están disponibles en la API
   1. Desmarca Incluir por Defecto y/o elimina el/los campo(s) por completo para limitar el acceso a través de la conexión API
6. Desde el panel de Tablas, haz clic en el ícono de Abrir Registro para expandir y ver el pop-up de Detalles del Recurso
   1. El Nombre del recurso deberá ser agregado a la URL Base y al Endpoint del Documento de API para recuperar esta información
7. Haz clic en Editar para establecer Límite de Obtención por Defecto o Límite Máximo de Obtención, estos valores controlan la cantidad de registros devueltos en las llamadas GET a tu endpoint de API
8. (Opcional, desde App Builder 4.51.) Abre el menú de Compatibilidad, luego selecciona una de las siguientes opciones:
   • Versión 1: Usa el comportamiento REST original—los eventos de Insertar no son precedidos por eventos de Nuevo. (Predeterminado para endpoints creados con App Builder 4.50 y anteriores.)
   • Versión 2: Usa un comportamiento REST mejorado—los eventos de Nuevo y cualquier regla predeterminada se invocan antes de los eventos de Insertar. (Predeterminado para endpoints creados con App Builder 4.51 y posteriores.)

Por último, configurarás las 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 API
   1. El Usuario debe estar configurado con el Tipo de Inicio de Sesión Interactivo
   2. 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

Opcionalmente, puedes configurar roles/grupos de seguridad para el/los Objeto(s) que se están accediendo como Endpoints.

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