En esta sección se explica cómo realizar una prueba sencilla una vez realizada una suscripción en la plataforma Reevolute Builder.
Primer Árbol
Antes que nada se debe poseer una suscripción de la plataforma, lo que entrega acceso a un tenant de la misma a través de un usuario WEB.
Cada tenant parte con un árbol de prueba llamado ‘myFirstTree’ que posee una versión con una lógica mínima, la que es expuesta al exterior mediante el release ‘test’. Esta configuración inicial permite realizar las primeras pruebas sobre el sistema.
Al ingresar a la plataforma se tendrá la siguiente vista en la que se muestra el árbol mencionado.
Al seleccionar el link que representa el nombre del árbol se obtiene información general del árbol, como la cantidad de versiones que posee, si hay alguna versión publicada (test/production), su identificador y descripción, lo que se muestra en la siguiente imagen.
Desde esta pestaña se puede acceder a la visualización de la lógica de negocio generada para el primer árbol. Esta lógica utiliza 5 tipos de nodo (inicio, bifurcación, conexión externa, ok y nok), lo que se muestra en la siguiente figura.
Seguridad API-KEY
Como estrategia de seguridad, la plataforma Reevolute Builder utiliza un API-KEY único asociado a cada suscripción/tenant. Es decir, para poder ejecutar árboles el ente externo debe conocer el parámetro API-KEY.
Este parámetro se puede obtener en la sección ‘Configuración’ a la que se accede mediante el ícono respectivo en la parte superior izquierda de la WEB. En la pestaña «API keys» de esa sección se puede obtener el parámetro.
Para crear un nuevo token se debe utilizar el botón ‘Nuevo token’ con el que se abre el formulario de creación. Además de los parámetros básicos de nombre y descripción, se deben definir los permisos que tendrá el token, así como su vigencia.
Una vez creado el token se debe almacenar en un lugar seguro, ya que no se podrá volver a obtener como medida de seguridad.
Ejecución Árbol
Con la intención de probar la lógica de un árbol, podemos utilizar el módulo «Probar la API» ubicado en el panel izquierdo de la WEB.
En este módulo se debe configurar:
- el token de acceso (API-KEY)
- el árbol que se desea ejecutar (‘myFirstTree’)
- el release (‘test’)
- JSON con parámetros de entrada
{
"type": "sync",
"parameters": {
"operation": "list_all"
}
}
Una vez configurados todos los parámetros, el sistema permitirá presionar el botón «Probar» que solicita la ejecución del árbol.
Una vez ejecutado el sistema muestra la respuesta obtenida:
{
"tree_version": "1",
"response_type": "COMMON",
"data": {
"description": "list users ok",
"error_code": "0",
"vars": {
"error_message": "OK",
"users": [
{
"address": "New York",
"age": 25,
"id": 0,
"name": "John",
"updated_at": "2023-09-06T18:57:08Z"
},
{
"address": "Seoul",
"age": 35,
"id": 1,
"name": "Grace",
"updated_at": "2023-09-06T18:57:08Z"
},
{
"address": "London",
"age": 25,
"id": 2,
"name": "Jane",
"updated_at": "2023-09-06T18:57:08Z"
},
{
"address": "Tokyo",
"age": 25,
"id": 3,
"name": "Natsumi",
"updated_at": "2023-09-06T18:57:08Z"
},
{
"address": "Mumbai",
"age": 45,
"id": 4,
"name": "Linbaba",
"updated_at": "2023-09-06T18:57:08Z"
}
]
}
}
}
El objeto de respuesta obtenido posee 3 parámetros en el primer nivel:
- tree_version, que define la versión del árbol que se ejecutó
- response_type, que define el tipo de árbol ejecutado
- data, objeto que contiene la respuesta definida en el árbol (tal como se vio más arriba)
Ejecución externa del árbol
Una aplicación externa deberá implementar el API REST de la plataforma Reevolute Builder para solicitar la ejecución de un árbol. Sin embargo, para probar externamente se puede aprovechar el comando «curl» existente en varios sistemas operativos.
La sintaxis del comando «curl» que permite ejecutar el árbol de prueba se puede obtener desde el mismo módulo «Probar API» antes mencionado.
curl -vvv -XPOST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer jhuBkGcxxxxxxxxxxxxxxxxxxxI-z-DSFR9' \
-d '{"type":"sync","parameters":{"operation":"list_all"}}' \
https://builder.api.reevolute.com/v2/tenants/msb_spz_7jz/trees/00000RWB61563AWJ5N5X49EKWJ/releases/test/executions
Reporte de transacciones
Cada ejecución de un árbol en la plataforma genera un registro en el reporte de transacciones, el que entrega información del request y response, tiempo de ejecución, así como la traza de la transacción a través del árbol.
En cada transacción se puede ampliar la información entregada, de tal forma de obtener mayor información tales como el request y response de esta.
Adicionalmente, se puede visualizar la «traza», es decir, el flujo que realizó la transacción dentro de la lógica del árbol, como se muestra en la siguiente figura. Además del ‘camino’ que siguió la transacción, en la pestaña «Actividad» se puede apreciar los nodos por los que pasó, así como los tiempos involucrados.
Desde dentro de la vista de la traza, en la secciones «Request» y «Response» se puede consultar la información relacionada con la invocación y respuesta del árbol.
En la sección «Actividad» para los nodos «conexión externa» se puede ver la información de entrada y salida intercambiada con el servicio externo.
