Consulta a Bureau — Visão Geral
Consulta a Bureau — Visão geral
Esta configuração define O QUE será consultado. O disparo efetivo da consulta na fase é feito por uma ação de fase do tipo agrisk, um recurso do domínio de ações de fase — não deve ser confundido com esta configuração.
Endpoints deste domínio
| Método | Caminho | Descrição |
|---|---|---|
GET | /v1/flows/{flowId}/phases/{phaseId}/query-config | Obtém a configuração de consulta a bureau da fase |
POST | /v1/flows/{flowId}/phases/{phaseId}/query-config | Cria a configuração de consulta a bureau da fase |
PUT | /v1/flows/{flowId}/phases/{phaseId}/query-config | Atualiza a configuração de consulta a bureau da fase |
Padrão de configuração recomendado
1.
GET) se já existe uma configuração de consulta para a fase.2.
POST) a configuração, informando title e a lista products[] com os identificadores dos produtos de bureau/AgRisk desejados.3.
agrisk (domínio de ações de fase), para que a consulta seja efetivamente disparada quando um card entrar na fase.Comportamentos importantes
POST/PUT é {title, products[]}. Ambos os campos são obrigatórios.products[] contém identificadores dos produtos de bureau/AgRisk a serem consultados — os identificadores disponíveis variam conforme o ambiente e a contratação do cliente.POST é tratado como uma atualização: a API retorna erro (409 ou 422), e o mesmo payload deve ser reenviado via PUT no mesmo caminho para concluir a atualização.PUT substitui integralmente o título e a lista de produtos anteriores — não é um merge parcial.agrisk correspondente. Criar a ação de fase sem a configuração de consulta previamente definida não é bloqueado pela API, mas a consulta não terá produtos definidos para buscar.agrisk: a query-config define quais produtos serão consultados; a ação de fase agrisk (parte do domínio de ações de fase) habilita o disparo dessas consultas quando o card entra na fase.Modificado em 2026-07-28 20:38:32