Documentação

Comece aqui

Primeiros passos

Do workspace vazio à primeira decisão, com o que conferir em cada passo.

O roteiro abaixo monta o caminho mínimo: um grupo de regras, uma Pipe e uma chamada. Cada passo diz onde clicar e o que você deve ver quando ele deu certo.

  1. 1Em Pipelines → Grupos de regras, crie um grupo (ex.: “Fundo CLT”) e cadastre os campos que a decisão usa — CPF, renda, idade —, marcando quais são obrigatórios. Confere: os campos aparecem na aba do grupo com tipo e obrigatoriedade.
  2. 2Monte a árvore de condições no editor de regras. Cada condição tem um campo, um operador e a mensagem que o cliente lê quando ela reprova. Confere: a árvore mostra os conectores E / OU entre os ramos.
  3. 3Use a Simulação, dentro do grupo, com um item de mentira. Ela roda o RASCUNHO e mostra o caminho da decisão. Confere: o resultado bate com o que você esperava — e nada foi cobrado nem entrou em relatório.
  4. 4PUBLIQUE o grupo. Enquanto ele estiver só em rascunho, é rascunho que roda em produção. Confere: a aba Versões mostra a v1, e o Histórico passa a registrar a versão que decidiu.
  5. 5Em Pipelines → Pipes, crie uma Pipe apontando para o grupo (ou para vários) e escolha a política de agregação. Confere: a Pipe mostra qual versão de cada grupo ela fixou.
  6. 6Chame a Pipe pela API com um item real. Para experimentar, use a rota síncrona — ela responde na hora. Confere: a resposta traz a decisão e o detalhe por grupo.
  7. 7Abra o Histórico → Validações. Confere: a chamada está lá, com a versão que decidiu e o item. Se estiver, o caminho todo está de pé.
A primeira chamada
curl -X POST https://rulor.com.br/api/pipes/pipe-credito/validate \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "payload": { "cpf": "12345678900", "renda": 4200, "idade": 33 },
    "item_key": "12345678900"
  }'
A resposta
{
  "esteira": "pipe-credito",
  "item_key": "12345678900",
  "decisao": "APPROVED",
  "grupos": {
    "fundo-clt": { "status": "APPROVED", "errors": [] },
    "banco-xpto": { "status": "APPROVED", "errors": [] }
  },
  "aprovados": ["fundo-clt", "banco-xpto"],
  "reprovados": []
}

Grupo sem publicação roda o rascunho

É o estado que ninguém quer descobrir por acaso em produção. O Histórico registra a versão que decidiu cada validação, e rascunho aparece lá como “sem versão” — com um aviso, porque significa que uma edição não publicada está valendo.

Depois que funcionar, troque a rota

A síncrona é para experimentar e integrar. O fluxo de produção é /validate/async: ela enfileira, retenta sozinha quando um fornecedor cai e entrega o mesmo consolidado no seu callback.