Interfaz de Comunicación
Reevolute Builder posee una interfaz de comunicación (API) para que plataformas externas puedan interactuar con ella.
Especificación API
El API de Reevolute Builder utiliza el protocolo HTTPS y método POST para el intercambio de información.
Sigue las reglas de una interfaz tipo REST y consume/produce información codificada en JSON.
A continuación podrá descargar la especificación OpenAPI 3.0 de las operaciones disponibles.
Endpoints
La plataforma posee lo siguientes Endpoints.
Base Endpoint
https://builder.reevolute.com/
Tree Execution Endpoint
https://builder.reevolute.com/v2/tenants/$TENANT_ID/trees/$TREE_ID/releases/$RELEASE/executions
Encabezados
El API requiere el intercambio de algunos parámetros en el encabezado de la interfaz REST, algunos de ellos son mandatorios y otros opcionales.
El encabezado requerido es el siguiente:
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_KEY' \
-H 'X-SCE-Origin $X-SCE_Origin'
Los parámetros están descritos en la siguiente tabla.
| Parameter | M/O | Description |
|---|---|---|
| $API_KEY | M | API_KEY para ejecutar el árbol Ejemplo: eyJhbGciOiJSU..........6hDUYHJO5ta7HE |
| $X_SCE_Origin | O | Identificador global de la transacción que puede definirse en el origen. Si no se define, es generado por la plataforma. Ejemplo: eyJhbGciOiJSU..........6hDUYHJO5ta7HE |
Autenticación
Con el objetivo de permitir el uso del API de Reevolute Builder las plataformas clientes deben incluir en el encabezado (header) el parámetro ‘API_KEY’. Este parámetro es único para cada tenant/suscripción de la plataforma.
-H 'Authorization: Bearer $API_KEY'
