Skip to main content
El endpoint de setup-progress devuelve los recuentos de recursos configurados, el estado de la última ejecución y la disponibilidad de activación de un contexto en un solo agregado, de modo que un asistente de configuración o una lista de verificación de onboarding deriva su estado de una sola solicitud en lugar de muchas.

​
Obtener el progreso de configuración

​
Qué devuelve

  • status — el estado del ciclo de vida del contexto: DRAFT (en configuración), ACTIVE (en ejecución), PAUSED (suspendido) o ARCHIVED (retirado).
  • sources — recuentos de fuentes divididos por lado de conciliación: total, left, right.
  • fieldMaps.mappedSources — número de fuentes mapeadas: las que tienen un mapeo de campos, más las fuentes CAMT.053, que se automapean (el parser incorpora el mapeo ISO 20022 e ignora los mapeos de campos).
  • matchRules.total — recuento de reglas de conciliación del contexto.
  • schedules.total — recuento de programaciones del contexto.
  • lastRun — la ejecución de conciliación más reciente (id, status de PROCESSING/COMPLETED/FAILED y completedAt). Es null cuando el contexto nunca se ha ejecutado.
  • readiness — resumen de disponibilidad de activación (ver más abajo).
  • next — la siguiente acción de configuración determinista a ejecutar, o null cuando el contexto está listo (ver más abajo).

​
Disponibilidad y la lista de verificación

El bloque readiness indica si el contexto cumple todos los requisitos de activación:
missing contiene identificadores públicos estables de requisitos de activación que puedes asignar a elementos de la lista de verificación. Los valores posibles son:
  • context.activation.requirement.left-source — el contexto necesita al menos una fuente del lado LEFT.
  • context.activation.requirement.right-source — el contexto necesita al menos una fuente del lado RIGHT.
  • context.activation.requirement.source-mapping — al menos una fuente no está mapeada: no tiene mapeo de campos y no es una fuente CAMT.053 automapeada.
  • context.activation.requirement.match-rule — el contexto necesita al menos una regla de conciliación.
  • context.activation.requirement.fee-rule — el contexto habilita la normalización de comisiones pero no tiene ninguna regla de comisión. Este requisito es condicional: solo aparece cuando feeNormalization está definido (NET o GROSS) y refleja la precondición de ejecución, que exige que las reglas de comisión — no los esquemas de comisiones — no estén vacías.
Cuando un contexto pasa a ACTIVE antes de estar listo, la actualización se rechaza con 409 Conflict y el código MTCH-0103. Los detalles del problema enumeran los mismos identificadores públicos de requisitos de activación. Úsalos, o vuelve a consultar el progreso de configuración, para mostrar las indicaciones pendientes.

​
La siguiente acción

next convierte readiness.missing en una llamada concreta. Se deriva de missing[0] — el primer requisito no satisfecho en el orden estable de arriba — y es null cuando el contexto está listo:
  • requirementId — el identificador público de requisito de activación que satisface esta acción.
  • operationId, method, path — el endpoint que debes llamar para satisfacer el requisito.
  • requiredFields — los nombres de los campos que exige esa solicitud de creación. Nunca llevan valores; tú los proporcionas.
  • forSource — presente solo en la acción de mapeo de fuente, indicando la primera fuente sin mapear para que completes {sourceId} sin una consulta adicional.
La tabla completa de requisito a acción: Los dos requisitos de fuente resuelven a la misma operación createSource — el campo side es lo que los distingue.

​
Cómo usarlo durante la configuración

  1. Renderiza la lista de verificación. En cada paso del asistente, haz un GET a setup-progress y usa los recuentos (sources, fieldMaps, matchRules, schedules) para marcar los elementos completados.
  2. Controla el botón principal con next. En lugar de reimplementar el orden de los requisitos en el cliente, llama a la operación que indica next; después vuelve a leer setup-progress para obtener la acción siguiente.
  3. Controla el botón “Activate”. Habilita la activación solo cuando readiness.ready sea true; de lo contrario, lista readiness.missing como los pasos restantes.
  4. Muestra el estado de las ejecuciones. Una vez que lastRun esté presente, muestra su status y completedAt para que los operadores puedan confirmar que el contexto está produciendo resultados.
Como todo el estado proviene de una sola llamada, puedes hacer polling a este endpoint para mantener el asistente en tiempo real sin orquestar lecturas separadas de fuentes, reglas y ejecuciones.

​
Códigos de respuesta