Saltar al contenido principal

FINORA Orquestador

Estado: Beta

Primera versión en producción. El contrato puede cambiar; las operaciones para terceros se limitan a iniciar procesos, entregar mensajes y trabajar con tareas.

El Orquestador de FINORA ejecuta los procesos BPMN 2.0 que el banco modela y aprueba (por ejemplo, el alta de un cliente con aprobación de cumplimiento, o un asiento manual que por encima de un umbral exige un supervisor). Tu sistema participa en esos procesos desde fuera: inicia instancias, les entrega mensajes cuando ocurre algo en tu lado y completa tareas humanas. En esta documentación usamos https://orquestador.banco.example como URL de ejemplo.

Qué puedes hacer​

OperaciónRutaRol
Obtener un tokenPOST /api/v1/oauth/token—
Iniciar un proceso por su clavePOST /api/v1/process-instances/{key}:startORQ_OPERATOR
Iniciar un proceso por mensajePOST /api/v1/messages/{name}:startORQ_OPERATOR
Entregar un mensaje a una instancia en esperaPOST /api/v1/messages/{name}:deliverORQ_OPERATOR
Consultar una instanciaGET /api/v1/process-instances/{id}ORQ_OPERATOR, ORQ_APPROVER
Reintentar incidentes de una instanciaPOST /api/v1/process-instances/{id}/incidents/{jobId}:retry, …/incidents:retry-allORQ_OPERATOR
Listar tareasGET /api/v1/tasksORQ_OPERATOR, ORQ_APPROVER
Completar una tareaPOST /api/v1/tasks/{id}:completeORQ_APPROVER

La gestión de definiciones de proceso y de destinos (subir un BPMN, aprobarlo y activarlo) es administración del banco, con aprobación de cuatro ojos, y no forma parte de la API para terceros.

Guías​

  1. Iniciar procesos y entregar mensajes
  2. Tareas humanas

Convenciones​

  • Autenticación OAuth 2.0 client credentials. Tu cliente recibe uno o varios roles (ORQ_OPERATOR, ORQ_APPROVER).
  • Idempotency-Key opcional (recomendada) al iniciar procesos.
  • Errores application/problem+json con codigo estable.
Próximamente
  • Ejemplos de procesos BPMN publicables y la política de modelado para terceros.
  • La referencia interactiva: la especificación se genera con el servicio en ejecución y se publicará filtrada a las operaciones de esta página.

Referencia​

Consulta la referencia de la API.