Progreso de la configuración

​

Obtener el progreso de la configuración

curl -X GET "https://api.matcher.example.com/v1/contexts/{contextId}/setup-progress" \
  -H "Authorization: Bearer $TOKEN"

{
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "DRAFT",
  "sources": { "total": 2, "left": 1, "right": 1 },
  "fieldMaps": { "mappedSources": 2 },
  "matchRules": { "total": 3 },
  "schedules": { "total": 1 },
  "lastRun": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "COMPLETED",
    "completedAt": "2025-01-15T10:30:00Z"
  },
  "readiness": {
    "ready": true,
    "missing": []
  },
  "next": null
}

​

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: conteos de fuentes divididos por lado de coincidencia: total, left, right.
• fieldMaps.mappedSources: número de fuentes mapeadas. Este conteo cubre las fuentes con un mapa de campos, más las fuentes CAMT.053 automapeadas. Para esas, el parser incorpora el mapeo ISO 20022 e ignora los mapas de campos.
• matchRules.total: cantidad de reglas de coincidencia del contexto.
• schedules.total: cantidad de programaciones del contexto.
• lastRun: la ejecución de coincidencia más reciente (id, status de PROCESSING/COMPLETED/FAILED y completedAt). Es null cuando el contexto nunca se ejecutó.
• readiness: resumen de la preparación para la activación (ver abajo).
• next: la siguiente acción de configuración determinista que se debe tomar, o null cuando el contexto está listo (ver abajo).

​

Preparación y la lista de verificación

{
  "ready": false,
  "missing": [
    "context.activation.requirement.source-mapping",
    "context.activation.requirement.match-rule"
  ]
}

• 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 tiene mapeo: no tiene mapa de campos y no es una fuente CAMT.053 automapeada.
• context.activation.requirement.match-rule: el contexto necesita al menos una regla de coincidencia.
• 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. Aparece solo cuando configuras feeNormalization en NET o GROSS. Refleja la precondición de la ejecución, que exige que las reglas de comisión, no las tablas de comisiones, no estén vacías.

​

La siguiente acción

{
  "requirementId": "context.activation.requirement.source-mapping",
  "operationId": "createFieldMap",
  "method": "POST",
  "path": "/v1/contexts/{contextId}/sources/{sourceId}/field-maps",
  "requiredFields": ["mapping"],
  "forSource": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Bank statement"
  }
}

• requirementId: el identificador público de requisito de activación que esta acción cumple.
• operationId, method, path: el endpoint que se debe llamar para cumplir el requisito.
• requiredFields: los nombres de los campos que la solicitud de creación exige. Nunca llevan valores. Esos los aportas tú.
• forSource: presente solo para la acción de mapeo de fuente, y nombra la primera fuente sin mapear para que puedas completar {sourceId} sin una búsqueda aparte.

​

Cómo usarlo durante la configuración

1. Muestra la lista de verificación. En cada paso del asistente, haz un GET a setup-progress y usa los conteos (sources, fieldMaps, matchRules, schedules) para marcar los ítems completados.
2. Controla el botón principal desde next. No reimplementes el orden de los requisitos del lado del cliente. Llama a la operación que next nombra. Después vuelve a leer setup-progress para la siguiente acción.
3. Condiciona el botón “Activate”. Habilita la activación solo cuando readiness.ready sea true. Si no, lista readiness.missing como los pasos restantes.
4. Muestra la salud de la ejecución. Una vez que lastRun está presente, expón su status y completedAt para que los operadores confirmen que el contexto produce resultados.

​

Códigos de respuesta