Documentação
Comece aqui
O caminho de um item
Da entrada ao desfecho: clique em cada etapa para ver o que entra, o que acontece, o que sai — e em qual tela você acompanha aquilo.
Nem toda operação usa todas as etapas. As marcadas como opcionais só existem quando você as configura: uma integração que só chama a API para decidir usa três delas.
O item chega — por chamada da sua aplicação ou porque a Coleta o trouxe.
- Entra
- Um JSON com os dados do item (CPF, renda, matrícula…) e uma chave que o identifica.
- Acontece
- O Rulor confere quem está chamando, registra a entrada e coloca o item na fila da Pipe.
- Sai
- Um acionamento — a unidade que o produto conta e cobra, uma por item.
Onde acompanhar: Histórico → Validações
Quando não é você que chama: o Rulor busca os itens ou recebe por webhook.
- Entra
- Uma fonte cadastrada — uma rota paginada para buscar, ou uma URL de webhook para receber.
- Acontece
- No modo PULL o agendador dispara no horário definido e percorre as páginas. No PUSH o corpo cru é gravado assim que chega, antes de qualquer processamento.
- Sai
- Um item por linha trazida, cada um enfileirado para a Pipe que a fonte aponta.
Onde acompanhar: Coleta → Execuções · Coleta → Webhook
Busca em fornecedor externo o dado que o item não trouxe.
- Entra
- O item como chegou, e as rotas de fornecedor configuradas no grupo de regras.
- Acontece
- Cada fornecedor é chamado antes da avaliação, com cache, teto de tempo e orçamento. A resposta é injetada num namespace próprio.
- Sai
- O mesmo item, agora com os campos que vieram do fornecedor — e o custo de cada chamada registrado.
Onde acompanhar: Enriquecimento → Fornecedores · o trace de cada execução no Histórico
O motor avalia o item contra as condições de cada grupo de regras.
- Entra
- O item enriquecido e a versão do grupo que a Pipe fixou.
- Acontece
- Confere os campos obrigatórios; se estiverem todos lá, executa a árvore de condições (E / OU).
- Sai
- Um veredito por grupo: APPROVED, REJECTED (com a mensagem de cada regra) ou INSUFFICIENT_DATA.
Onde acompanhar: Histórico → Validações
A Pipe junta os vereditos dos grupos num só.
- Entra
- O veredito de cada grupo que a Pipe roda.
- Acontece
- Agrega pela política escolhida — TODOS aprovam, ALGUM aprova, ou SEMPRE (não agrega e deixa o destino ler grupo a grupo).
- Sai
- Um consolidado: a decisão final e o detalhe por grupo. É ele que vai no callback.
Onde acompanhar: Histórico → Validações · o callback da rota assíncrona
A decisão vira oportunidade no destino — CRM, parceiro, sistema próprio.
- Entra
- O consolidado e a cadeia de saída cadastrada na Pipe (ou na fonte de coleta).
- Acontece
- Cada elo da cadeia tem um filtro (“só quando aprovado”) e um corpo montado por template. Cada despacho tem chave de idempotência.
- Sai
- Uma oportunidade criada no destino, com o id que ele devolveu — e o diálogo inteiro guardado.
Onde acompanhar: Histórico → Oportunidades
Quando a oportunidade é repartida entre empresas parceiras por peso e teto.
- Entra
- Um grupo de distribuição com os destinos, cada um com peso, limite diário e link próprio.
- Acontece
- O rodízio escolhe de quem é a vez, respeitando a proporção declarada e o teto do dia de cada parceiro.
- Sai
- Uma entrega: este item, para este parceiro, com o link dele.
Onde acompanhar: Distribuição → Entregas
A pessoa abre o link e é levada ao destino — e a passagem fica registrada.
- Entra
- Um acesso ao endereço público do link.
- Acontece
- O Rulor amarra o acesso à proposta pela cascata configurada, grava a trilha e redireciona.
- Sai
- Um 302 para o destino, e uma linha na trilha com hora, origem e a proposta encontrada.
Onde acompanhar: Distribuição → Visão geral (trilha do item)
O parceiro devolve o que aconteceu com a oportunidade: vendeu, perdeu, ainda está analisando.
- Entra
- Uma chamada do parceiro na rota de retorno que você criou para ele.
- Acontece
- O vocabulário dele é traduzido para o canônico (ganho / perdido / em andamento / descartado) e a operação é reencontrada pela cascata de vínculo.
- Sai
- Um desfecho — o estado comercial corrente daquele item naquele parceiro.
Onde acompanhar: Retornos → Funil, Retornos e Desfechos
Tudo o que aconteceu fica consultável — item a item e em números.
- Entra
- Os registros de cada etapa acima.
- Acontece
- Filtros por período, grupo, Pipe, status; a trilha reúne as etapas de UM item na ordem do tempo.
- Sai
- A resposta para “o que aconteceu com este item” e para “quanto processamos”, em tela e em CSV.
Onde acompanhar: Histórico · Relatórios · Dashboard
O mínimo funcionando são três etapas
Um grupo de regras publicado, uma Pipe apontando para ele, e a sua aplicação chamando a Pipe. Coleta, enriquecimento, saída, distribuição e retorno entram depois, um de cada vez — cada um resolve um problema diferente e nenhum é pré-requisito do outro.
As etapas dependem umas das outras na ordem em que aparecem: o enriquecimento só ajuda se a coleta trouxe o item, as regras só decidem sobre o que chegou até elas, e a saída só despacha o que a Pipe consolidou. Quando algo “não funcionou”, a pergunta útil é sempre “até onde o item chegou” — e é essa a pergunta que a trilha do item responde.