Validações
Confira o resultado final do template de IDP com validações por código, por chamada a uma API ou por um robô: campos, regra de aprovação de cada tipo, mapeamento de entradas do robô e motivos de reprovação.
Validações
As validações são verificações que o resultado final do template precisa passar. Elas formam uma lista executada de cima para baixo, com os controles de cartão descritos em Pipeline, e cada uma aprova ou reprova o resultado.
| Tipo | O que faz |
|---|---|
| Código | Aprova ou reprova o resultado com um script. |
| API | Envia o resultado a uma API, que responde se ele passa. |
| Robô (RPA) | Executa um robô de verdade, inclusive nos testes, e usa a resposta dele como veredito. |
Toda validação tem um Nome, que aparece no cartão e nos resultados, por exemplo "Total confere com os itens" ou "CNPJ ativo na Receita".
O que as validações recebem
Todas as validações recebem o mesmo resultado final: a saída da última etapa de pós-processamento ou, sem pós-processamento, o resultado da extração.
Todas as validações ativas são executadas, mesmo quando uma delas reprova. Uma reprovação não interrompe o pipeline nem faz a execução falhar: a execução termina como Concluída, e o resultado registra quais validações passaram e, para as reprovadas, o motivo. No Playground, a aba Validações mostra o placar, por exemplo "2/3 aprovadas". Validações desativadas não são executadas.
Sem nenhuma validação, todo resultado é aceito.
Validação por código
A validação por Código roda um script em Node.js (padrão) ou Python com o mesmo contrato das etapas de código do pós-processamento: input contém o resultado final, e o veredito é o valor atribuído a output. Em Node.js, params traz os parâmetros enviados na chamada.
Valor de output | Veredito |
|---|---|
true / True | Aprovada. |
false / False | Reprovada. |
{ passed, reason } (em Python, {"passed": bool, "reason": str}) | Aprovada ou reprovada conforme passed; reason explica a reprovação. |
| Qualquer outro valor | Reprovada, com um motivo que mostra o valor recebido. |
Se o script lançar um erro, a validação reprova com a mensagem do erro. Uma validação sem código reprova sempre. Motivos com mais de 500 caracteres são cortados.
const soma = input.itens.reduce((total, item) => total + Number(item.valor), 0);
output = soma === Number(input.total)
? true
: { passed: false, reason: "Total não confere" };
Validação por API
A validação por API faz uma requisição HTTP a um endpoint seu, que decide se o resultado passa.
| Campo | Padrão | Descrição |
|---|---|---|
| Endpoint | POST | O método — GET, POST, PUT, PATCH ou DELETE — e a URL chamada. |
| Cabeçalhos | — | Pares de nome e valor enviados na requisição, por exemplo um token de autenticação. |
A requisição é enviada com Content-Type: application/json, e o resultado final vai no corpo, como JSON, exceto em GET e DELETE, que não têm corpo.
Qualquer resposta 2xx aprova. Outro status reprova com o motivo "A API respondeu com status N"; uma falha de conexão reprova com a mensagem do erro. A resposta da API fica registrada no resultado da validação.
Cabeçalhos ficam salvos no template e vão junto quando ele é exportado. Veja Geral.
Validação por robô
A validação por Robô (RPA) dispara um robô do workspace e usa a resposta dele como veredito. O robô roda de verdade em todas as execuções, inclusive no Playground, no Simular API e na Base de testes.
| Campo | Padrão | Descrição |
|---|---|---|
| Robô | — | O robô executado. A busca é feita pelo nome. |
| Entradas do robô | — | Para cada entrada que o robô declara, o caminho do valor que ela recebe. |
| Tempo limite (segundos) | 300 | De 1 a 840. Se o robô não responder nesse tempo, a validação reprova. |
Entradas do robô
O robô recebe dados pelas entradas que declara com a ação Obtém entradas de um Webhook. Para cada entrada, informe um caminho a partir de:
payload— o resultado final, por exemplopayload.cnpjoupayload.emitente.nome;params— os parâmetros enviados na chamada ao template, por exemploparams.cliente.
O campo sugere caminhos a partir da última execução do Playground. Uma entrada cujo caminho não existe no resultado não é enviada. Se o robô não declara entradas, ele não recebe dados do resultado.
Resposta do robô
O robô precisa responder com um objeto { passed, reason }, em que passed é verdadeiro ou falso e reason explica a reprovação, por exemplo com a ação Responder Webhook. Sem essa resposta, a validação sempre reprova. Quando o robô escolhido não tem essa ação ou a resposta dele não declara o campo passed, o cartão mostra um aviso.
O tempo limite nunca passa do tempo que ainda resta à execução do template; se restarem menos de 5 segundos, a validação reprova por tempo esgotado.
Motivos de reprovação
Além de passed: false, a validação por robô reprova nestes casos:
| Motivo | Quando acontece |
|---|---|
| Robô não configurado | Nenhum robô foi selecionado na validação. |
| Robô não encontrado | O robô não existe, está inativo ou pertence a outro workspace. |
| Dispositivo inacessível | O dispositivo do robô está offline ou inacessível. |
| Erro do robô | O robô terminou com erro. |
| Sem veredito | O robô terminou sem devolver um veredito com passed. |
| Tempo esgotado | O robô não respondeu dentro do tempo limite. |
| Recurso fora do plano | O plano do workspace não inclui a execução de robôs por webhook. |