Progresso da configuração

​

Obter o progresso da configuração

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
}

​

O que ele retorna

• status: o status do ciclo de vida do contexto: DRAFT (em configuração), ACTIVE (em execução), PAUSED (suspenso) ou ARCHIVED (retirado de uso).
• sources: contagens de fontes divididas por lado da correspondência: total, left, right.
• fieldMaps.mappedSources: número de fontes mapeadas. Essa contagem cobre as fontes com mapa de campo, mais as fontes CAMT.053 automapeadas. Para essas, o parser embute o mapeamento ISO 20022 e ignora os mapas de campo.
• matchRules.total: número de regras de correspondência do contexto.
• schedules.total: número de agendamentos do contexto.
• lastRun: a execução de correspondência mais recente (id, status entre PROCESSING/COMPLETED/FAILED e completedAt). É null quando o contexto nunca rodou.
• readiness: resumo da prontidão para ativação (veja abaixo).
• next: a próxima ação determinística de configuração a executar, ou null quando o contexto está pronto (veja abaixo).

​

Prontidão e o checklist

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

• context.activation.requirement.left-source: o contexto precisa de pelo menos uma fonte do lado LEFT.
• context.activation.requirement.right-source: o contexto precisa de pelo menos uma fonte do lado RIGHT.
• context.activation.requirement.source-mapping: pelo menos uma fonte está sem mapeamento: ela não tem mapa de campo e não é uma fonte CAMT.053 automapeada.
• context.activation.requirement.match-rule: o contexto precisa de pelo menos uma regra de correspondência.
• context.activation.requirement.fee-rule: o contexto habilita a normalização de tarifas, mas não tem regra de tarifa. Esse requisito é condicional. Ele aparece apenas quando você define feeNormalization como NET ou GROSS. Ele espelha a precondição de execução, que exige que as regras de tarifa, não as tabelas de tarifas, não estejam vazias.

​

A próxima ação

{
  "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: o identificador público de requisito de ativação que essa ação atende.
• operationId, method, path: o endpoint a chamar para atender o requisito.
• requiredFields: os nomes dos campos que a requisição de criação exige. Eles nunca carregam valores. Você os fornece.
• forSource: presente apenas na ação de mapeamento de fonte, nomeando a primeira fonte sem mapeamento para você preencher {sourceId} sem uma consulta separada.

​

Como usar durante a configuração

1. Monte o checklist. Em cada passo do assistente, faça GET no setup-progress e use as contagens (sources, fieldMaps, matchRules, schedules) para marcar os itens concluídos.
2. Comande o botão principal pelo next. Não reimplemente a ordem dos requisitos no cliente. Chame a operação que next nomeia. Depois releia o setup-progress para saber a próxima ação.
3. Controle o botão “Ativar”. Habilite a ativação apenas quando readiness.ready for true. Caso contrário, liste readiness.missing como os passos restantes.
4. Mostre a saúde das execuções. Quando lastRun estiver presente, mostre o status e o completedAt dele para que os operadores confirmem que o contexto produz resultados.

​

Códigos de resposta