Pular para o conteúdo principal
POST
/
v1
/
matching
/
simulate
Simular uma regra de correspondência contra um contexto (execução seca somente leitura)
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/matching/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contextId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sampleLimit": 25
}
'
{
  "matchedGroups": 1,
  "ruleType": "<string>",
  "sample": [
    {
      "amountDelta": "<string>",
      "dateDeltaDays": 123,
      "left": {
        "amount": "<string>",
        "currency": "<string>",
        "date": "<string>",
        "id": "<string>",
        "sourceId": "<string>",
        "baseAmount": "<string>",
        "externalId": "<string>"
      },
      "right": {
        "amount": "<string>",
        "currency": "<string>",
        "date": "<string>",
        "id": "<string>",
        "sourceId": "<string>",
        "baseAmount": "<string>",
        "externalId": "<string>"
      },
      "score": 50,
      "why": {
        "amountMatch": true,
        "currencyMatch": true,
        "dateMatch": true,
        "referenceScore": 0.5,
        "matchedKeys": [
          {
            "agreed": true,
            "field": "<string>"
          }
        ]
      }
    }
  ],
  "sampleTruncated": true,
  "unmatchedLeft": 1,
  "unmatchedRight": 1,
  "ruleId": "<string>"
}

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Corpo

application/json
contextId
string<uuid>
obrigatório

ID do contexto contra cujas transações a regra é simulada

rule
object

Regra candidata inline para pré-visualizar. Forneça esta OU ruleId, não ambos.

ruleId
string<uuid>

Identificador de uma regra configurada existente a pré-visualizar. Forneça esta OU rule, não ambas.

sampleLimit
integer<int64>
padrão:25

Número máximo de pares que corresponderiam a retornar na amostra

Intervalo obrigatório: 1 <= x <= 200

Resposta

OK

matchedGroups
integer<int64>
obrigatório

Número de grupos 1:1 que a regra formaria no contexto

Intervalo obrigatório: x >= 0
Exemplo:

12

ruleType
string
obrigatório

Estratégia da regra pré-visualizada

Exemplo:

"EXACT"

sample
object[] | null
obrigatório

Amostra limitada de pares que corresponderiam (maior pontuação primeiro)

Maximum array length: 200
sampleTruncated
boolean
obrigatório

Se matchedGroups excede o comprimento da amostra retornada

Exemplo:

false

unmatchedLeft
integer<int64>
obrigatório

Transações do lado esquerdo que permaneceriam sem correspondência

Intervalo obrigatório: x >= 0
Exemplo:

3

unmatchedRight
integer<int64>
obrigatório

Transações do lado direito que permaneceriam sem correspondência

Intervalo obrigatório: x >= 0
Exemplo:

5

ruleId
string

Identificador da regra pré-visualizada. Vazio para uma regra candidata inline (não persistida).

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"