Publicar App Builder aplicación Como Extremo de API REST¶

Descripción General¶

En App Builder puedes configurar an App Builder servidor para que sea una API de modo que se pueda acceder a los datos de la aplicación a través de una clave API. Esta función le permite crear una clave API y Extremos en las aplicaciones. Esta guía mostrará un ejemplo que utiliza datos de Northwinds y utiliza una clave API para conectarse a un Extremo creado en una aplicación seleccionada.

Cómo Publicar App Builder aplicación Como Extremo de API REST¶

Primero deberá configurar una clave API de proveedor de seguridad para proporcionar autenticación para acceder a los Extremos:

1. Vaya a IDE > Proveedores de seguridad
2. Haga clic en + Autenticación de usuario en el panel Autenticación de usuario
3. Asigna un Nombre al proveedor. Por ejemplo: Clave API
4. Seleccione Clave API como valor de Tipo
5. Marque para seleccionar Habilitado
6. Haga clic en Guardar

Dependiendo de su caso de uso, puede configurar las siguientes propiedades:

1. Si desea escribir la API en la barra de ubicación de su navegador para realizar pruebas (no es muy seguro), entonces
   1. Haga clic en + Propiedad en el panel Propiedades
   2. Seleccione AllowApiKeyInQueryString como parámetro
   3. Ingrese Verdadero como valor
   4. Haga clic en la marca de verificación para guardar el registro
2. Si está utilizando HTTP, configuración no recomendada, entonces debe agregar lo siguiente:
   1. Haga clic en Crear
   2. Seleccione AllowInsecureHttp como el parámetro
   3. Ingrese Verdadero para el valor
   4. Haga clic en la marca de verificación para guardar el registro

A continuación, deberá configurar un Extremo para acceder a una fuente de datos de aplicaciones:

1. Vaya a IDE > APIs REST
2. Haga clic en el botón Administrar Extremos en el panel de aplicaciones.
3. Seleccione la aplicación donde desea configurar el Extremo. Por ejemplo: Northwinds Design
4. Haga clic en el ícono de edición lápiz de la aplicación.
5. Introduzca el valor del Extremo en el campo Extremo. Por ejemplo: Northwinds
6. Haga clic en el botón Continuar

A continuación, publicará el Extremo que creó en el paso anterior:

1. Vaya a IDE > APIs REST
2. Haga clic en el ícono Doc de la API para ver la información que necesitará más adelante para conectarse a este Extremo.
3. Haga clic en + Objeto de negocio en el panel Objetos de negocio y seleccione una Tabla para establecer un valor para el Extremo. Por ejemplo: Categoría (Origen)
4. Haga clic en el icono de marca de verificación para guardar el registro
5. Haga clic en el ícono Estructura para controlar qué campos están disponibles en la API
   1. Desmarque Incluir por defecto y/o elimine los campos por completo para limitar el acceso a través de la conexión API
6. Desde el panel Tablas, haga clic en el ícono Abrir registro para expandir y ver la ventana emergente Detalles del recurso
   1. Será necesario agregar el Nombre del recurso a la URL base y al Extremo del documento API para recuperar esta información.
7. Haga clic en Editar para establecer el Límite de obtención predeterminado o el Límite máximo de obtención; estos valores controlan la cantidad de registros devueltos en las llamadas GET a su extremo de API.

Por último, configurarás claves API para usuarios específicos:

1. Vaya a IDE > Administración de usuarios
2. Seleccione un usuario existente o cree 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 de usuario seleccionado/creado, haga clic en el ícono Teclas
4. Haga clic en Crear y seleccione la clave API creada en el primer paso como Proveedor
5. Haga clic en Guardar
6. La clave generada es la que utilizará el Usuario para acceder a la API publicada.

Opcionalmente, puede configurar roles/grupos de seguridad para los objetos a los que se accede como Extremos.

Para probar o configurar el uso de sus nuevos extremos de API, utilice la Clave de API **del paso anterior, la URL base** y la información del Extremo del documento de API, y el Nombre de los detalles del recurso.