Introducción

Este tipo de Entidad se crea a partir de una API REST, ya sea externa a Onesait Platform o de la propia Plataforma. En el primer caso, los datos no serán almacenados en la Plataforma, sino que todas las operaciones sobre estas Entidades serán derivadas a la API REST.

Pasos

Crear la Entidad

Desde el Control Panel, navegaremos al menú de Development > My Entities.

Esto nos llevará al listado de Entidades disponibles. Para crear la Entidad, pulsaremos en el botón de «+» situado en la parte superior derecha de la pantalla.

De las distintas Entidades que vamos a poder crear, seleccionaremos la de «Creation from a REST API»:

Rellenar la información general

Esto nos abrirá el asistente de creación de Entidades, en donde al igual que el resto de Entidades tendremos que introducir una información básica:

• Identification: el nombre único con el que identificar a la Entidad.

• Meta-Information: etiquetas con las que caracterizar la Entidad, que servirán para su filtrado a la hora de hacer búsquedas.

• Description: texto descriptivo extendido de la Entidad, como su uso, propiedades, características, etc.

• Base URL: dirección del servicio API REST con el que vamos a trabajar. Una URL de ejemplo sería la siguiente:

https://dog.ceo/api/breeds/list/

Además, contamos con las opciones de caracterización de las Entidades:

• Active: para que la Entidad funcione o se encuentre bloqueada.

• Public entity: si queremos que la Entidad sea pública, o si la queremos privada.

• Allows encryption of fields: permite el uso de campos encriptados.

• ContextData Enable: si queremos que la Entidad registre internamente los cambios de escritura y gestión.

Una vez rellena toda esta información, pulsaremos en el botón de «Continue» para terminar de configurar la Entidad.

Configurar las cabeceras

Si el servicio API REST requiere de una autorización para usarlo, ya sea básica o por API Key, podremos configurarlo en esta sección. Para ello deberemos activar la opción de «Enable Authentication».

Rellenaremos los datos que necesitemos en cada caso. Para nuestro ejemplo no usaremos autentificación, por lo que podremos dejar desactivada la opción.

En caso de que necesitemos utilizar algún otro tipo de cabecera, podremos definirlas en la siguiente sección:

Añadir las operaciones disponibles

Existen dos opciones para añadir operaciones al API REST; importarlas desde el Swagger del servicio API REST, o añadirlas a mano.

Importar operaciones desde Swagger

En este caso, añadiremos la URL del Swagger del API REST para importar las operaciones disponibles:

Definir las operaciones a mano

Si no se encuentra disponible un Swagger, o si no nos interesa tener todas las operaciones sino definir las que nos interese, podremos creadas a mano.

Para la URL del API de perros, añadiremos una operación con los siguientes campos:

• Name: el nombre con el que identificaremos la operación. En este caso: «getAll».

• Path: la ruta de la operación a ejecutar. En este caso «all» (más información).

• Type: el tipo de operación que vamos a crear. En este caso «GET».

• Description: un pequeño texto descriptivo de la operación a crear. Aquí introduciremos cualquier descripción que nos parezca de interés.

• Default Operation Type: el tipo de operación que llevará a cabo.

Operaciones POST

Para poder realizar operaciones de tipo POST, es preciso definir el esquema de destino para que las operaciones de escritura se puedan llevar a cabo.

Este esquema se definirá en la sección de «Schema»:

Completado este último paso, finalizaremos la creación de la Entidad pulsando en el botón de «Create»:

Comprobar los datos

Una creada la Entidad, vamos a poder consultar su contenido desde la herramienta de consulta que encontraremos en Tools > Query Tool.

Ahí, seleccionaremos la Entidad que acabamos de crear y podremos ver el contenido que veríamos en caso de lanzar el servicio API REST: