Creación de APIs con el FlowEngine

Esta opción te permite crear APIs con la potencia de las funciones del FlowEngine.

Para crear una API desde el FlowEngine, sigue los siguientes pasos:

1. Selecciona la opción "Mis Flujos Digitales" del menú Desarrollo:

   Open

   

    

2. Selecciona el dominio y haz clic en el botón "Ver":

   Open

   

    

3. Busca los nodos de tipo "onesaitplatform API". Verás que aparecen tres nodos distintos:

    

4. Arrastra un nodo tipo "onesaitplatform api rest" y haz doble clic sobre él. Se abrirán las propiedades del nodo y puedes rellenar los campos:

   • Name: Nombre que darás a la API.

   • Description: Descripción detallada de la API.

   • Categories: Selecciona una categoría a la que pueda corresponder la API de entre las del desplegable.

   • Is Public: Con este check box indicas si la API va a ser pública.

      

5. Arrastra un nodo "onesaitplatform api rest operation", únelo al nodo anterior y haz doble clic en él para editar sus propiedades. Rellena los siguientes campos:

   • Method: Método de la operación de la API REST (GET | PUT | POST | DELETE).

   • URL: Path de la operación.

   • Name: Nombre que das a la operación.

   • Description: Descripción detallada de la operación.

   • Query Params: JSON donde se declararán cada uno de los parámetros de la query, junto con su tipo.

      

   • En el caso de querer definir path/query params, puedes hacerlo de la siguiente manera:

     • Path params: Se definen en el path con un nombre precedido del carácter ':', por ejemplo:

       y se pueden recuperar en el siguiente nodo a través de msg.req.params.<nombre-del-parámetro>

     • Query params: Se definen explícitamente mediante un json donde se indica el nombre del parámetro y su tipo:

       y se pueden recoger en el siguiente nodo a través de msg.req.query.<nombre-del-parámetro>:

        

6. Para cada operación tienes que implementar la lógica según sea necesario. En este ejemplo, puedes usar nodos "Function" que realizarán las operaciones que estimes oportunas.

7. Una vez se haya implementado la lógica necesitada, debes cerrar el flujo de cada operación con una respuesta (nodo "onesaitplatform api rest operation response"). Este nodo será el encargado de devolver tanto el cuerpo del mensaje de respuesta en "msg.payload" como un status code. Este último será 200 por defecto pero puedes cambiarlo de dos maneras:

   • poniendo el código de retorno en el nodo directamente,

   • o haciendo que lo pase un nodo anterior en msg.statusCode

      

8. Una vez estés satisfecho con tus operaciones sobre la API, haz clic en el botón "Deploy" para que los cambios se guarden en la plataforma:

    

9. Al igual que en el resto de APIs que se pueden crear en la plataforma, la definición estará accesible a través del API Manager. Desde aquí puedes probarla desde swagger.