Licitar Digital

43 min

Conector Licitar Digital

Visão Geral

O conector Licitar Digital permite que fluxos da Fluid consumam e disparem operações nos serviços públicos e privados expostos pelas APIs do Licitar Digital.

Recursos Disponíveis

Processos de compra pública - Gestão completa de processos licitatórios

Webhooks de chat - Integração de comunicação em tempo real

NFSe - Gerenciamento de notas fiscais de serviço eletrônicas

Faturas - Controle de faturamento e pagamentos

Organização - Gerenciamento de unidades organizacionais

Integrações - Atualizações e sincronização de dados

Documentação Oficial da API

API Pública Licitar Digital

API Partner Licitar Digital

Configuração

Criando uma Conexão

Para configurar o conector, você precisará fornecer as seguintes credenciais:

Campo	Tipo	Obrigatório	Descrição
user	string	Sim	Usuário de autenticação
token	string (secreto)	Sim	Token de acesso à API
ambiente	enum	Sim	Ambiente de execução (sandbox ou produção)

⚠️ Segurança: O token deve ser protegido e nunca exposto em logs ou repositórios públicos.

Configurando um Fluxo

Ao configurar um passo com o conector Licitar Digital:

Selecione o Resource (recurso da API)

Escolha a Operation (operação desejada)

Preencha os parâmetros necessários

Parâmetros comuns:

offset - Paginação: posição inicial dos resultados

limit - Paginação: quantidade máxima de registros

headers - String JSON com cabeçalhos HTTP adicionais

Recursos e Operações

1. Webhook - Chat

Gerenciamento de webhooks para integração de chat.

Criar Webhook

Registra um novo webhook para receber eventos de chat.

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
method	string	Sim	Método HTTP (GET, POST, etc.)
url	string	Sim	URL de destino do webhook
headers	string	Sim	Cabeçalhos HTTP em formato JSON

Incluir Webhook

Adiciona webhook ao processo sem campos adicionais requeridos.

Listar Webhooks

Lista webhooks associados a um processo.

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
processId	string	Sim	ID do processo
offset	string	Não	Paginação: posição inicial
limit	string	Não	Paginação: limite de registros

Excluir Webhook

Remove um webhook existente.

Parâmetros:

Campo	Tipo	Obrigatório
processId	string	Sim

2. NFSe (Notas Fiscais de Serviço Eletrônicas)

Gerenciamento de notas fiscais eletrônicas.

Listar Faturas Pendentes

Retorna faturas que aguardam processamento.

Parâmetros:

Campo	Tipo	Obrigatório
offset	string	Não
limit	string	Não

Atualizar Status da Fatura

Atualiza informações e status de uma fatura NFSe.

Campo obrigatório: updateStatus

Opções de updateStatus:

dinamicFields

Atualização com campos dinâmicos completos.

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	ID da fatura
nfseStatus	string	Sim	Status da NFSe
nfseId	string	Não	Identificador da NFSe
nfsePdfUrl	string	Não	URL do PDF da NFSe
nfseXmlUrl	string	Não	URL do XML da NFSe
nfseNumber	string	Não	Número da NFSe

template

Atualização via template pré-configurado (sem campos adicionais).

3. Processos

Gerenciamento de processos licitatórios.

Obter Dados do Processo

Recupera informações detalhadas de um processo.

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
headers	string	Sim	Cabeçalhos HTTP em JSON
ambiente	object	Sim	Ambiente de execução
unitId	string	Sim	ID da unidade organizacional
id	string	Não	ID interno do processo
externalId	string	Não	ID externo do processo

Cadastrar Processo

Cria um novo processo no sistema.

Parâmetros:

Campo	Tipo	Obrigatório
headers	string	Sim
ambiente	object	Sim

Atualizar Processo

Atualiza dados de um processo existente.

Parâmetros: Mesmos campos da operação "Obter Dados do Processo".

4. Faturas

Controle de faturamento e pagamentos.

Obter Faturas Pendentes

Lista faturas aguardando processamento (sem parâmetros adicionais).

Atualizar Faturas

Atualiza informações de faturamento.

Campo obrigatório: updateStatus

Opções de updateStatus:

dinamicFields

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	ID da fatura
price	string	Sim	Valor da fatura
bankSlipUrl	string	Sim	URL do boleto bancário
invoiceUrl	string	Sim	URL da nota fiscal
description	string	Sim	Descrição da fatura
invoiceNumber	string	Sim	Número da nota fiscal
trasactionId	string	Sim	ID da transação

template

Atualização via template (sem campos adicionais).

5. Organização

Gestão de unidades organizacionais.

Obter Organização

Recupera dados de uma organização.

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
organizationUnitId	string	Não	ID da unidade organizacional
integration	string	Não	Tipo de integração

6. Gerenciamento

Operações de manutenção e atualização de integrações.

Atualizar Processo

Atualiza diferentes aspectos de um processo.

Campo obrigatório: update_type

Opções de update_type:

process

Atualização de dados do processo.

Campo	Tipo	Obrigatório
id	string	Sim
pncpLink	string	Sim

lotItems

Atualização de itens de lote (mesmos campos de process).

logs

Registro de logs de integração.

Campo	Tipo	Obrigatório	Descrição
processId	string	Sim	ID do processo
typeIntegration	string	Sim	Tipo de integração
status	string	Sim	Status da operação
statusText	string	Sim	Texto descritivo do status
responseMessage	string	Sim	Mensagem de resposta

Exemplo Prático

Fluxo: Atualização de Processo via Webhook Chat

Este exemplo demonstra como processar webhooks do Licitar Digital e atualizar dados de processos em tempo real.

Cenário

Receber o ID do processo por evento, verificar se há dados de Webhook Chat a serem atualizados, e caso haja, processar e retornar ao requisitante o status da operação.

Estrutura do Fluxo

[Trigger] → [Listar] → [Verifica] → [Loop] → [Inscrição] → [Headers] → [Envia-chat]

Passos do fluxo:

Trigger (Evento) - Recebe o processId via webhook externo

Listar (Webhook - Chat) - Lista webhooks associados ao processo

Verifica - Valida se existem webhooks pendentes de processamento

Loop - Itera sobre cada webhook encontrado (initial → next → exit)

Inscrição - Prepara dados de inscrição

Headers - Formata cabeçalhos HTTP necessários

Envia-chat - Dispara o conector para atualizar o webhook

Configuração do Passo "Listar"

Resource: Webhook - Chat Operation: Listar

Parâmetros:

Campo	Valor	Descrição
Id	{{.input.body.processId}}	ID do processo recebido no evento
Offset	0	Início da paginação
Limit	100	Máximo de 100 registros por consulta

Payload de Entrada (Webhook recebido)

{
  "data": [
    {
      "headers": [
        "Authorization: Basic bGljaXRhWHhjaWlkaGFXdpdGdFs0jR3VkYqV0BmwQGo1Sl9qYUxMWEFy"
      ],
      "id": "2d371054-e7c3-44b9-bac6-be95c877c43c",
      "method": "POST",
      "processId": 83393,
      "url": "https://webhook.effecti.com.br/licitar-digital/"
    },
    {
      "headers": [
        "Authorization: Basic M2MyNTBlMTUtNzZhNi00YWzmLTlmYjItYTQzY2UxMjc1MjMxOmIxMTdGiNmMtNGU1My0..."
      ],
      "id": "2fe4145f-70bb-493c-bacb-ba33210632fa",
      "method": "POST",
      "processId": 83393,
      "url": "https://app.elicitacao.com.br/radarapi/webhook/licitar_digital"
    }
  ]
}

Resposta Esperada

Após o processamento completo do fluxo, o sistema retorna o status da atualização de cada webhook processado, confirmando:

✅ Webhooks identificados e processados com sucesso

✅ Headers de autenticação validados

✅ Requisições disparadas para as URLs configuradas

✅ Status de integração atualizado

Boas Práticas

Tratamento de erros:

Implemente validação no passo "Verifica" para evitar loops infinitos

Configure timeout adequado para requisições HTTP

Registre logs de cada iteração do loop para auditoria

Performance:

Ajuste o limit conforme o volume esperado de webhooks

Utilize paginação (offset) para grandes volumes de dados

Considere processamento assíncrono para múltiplos webhooks

Segurança:

Valide o token de autorização antes de processar

Utilize variáveis de ambiente para armazenar credenciais sensíveis

Implemente retry logic para falhas temporárias de rede

Casos de Uso Comuns

1. Sincronização de Processos Licitatórios

Mantenha processos atualizados em tempo real através de webhooks, garantindo que mudanças de status sejam refletidas imediatamente em sistemas integrados.

2. Automação de NFSe

Processe automaticamente a emissão e atualização de notas fiscais eletrônicas vinculadas a processos de compra, reduzindo trabalho manual e erros.

3. Notificações em Tempo Real

Configure webhooks de chat para disparar notificações instantâneas a equipes responsáveis sempre que houver atualizações críticas em processos.

4. Integração com ERPs

Sincronize dados de faturas e processos entre o Licitar Digital e sistemas ERP corporativos, mantendo consistência de dados financeiros.

Disparando o Fluxo

O fluxo pode ser acionado através de:

Execução manual - Disparo direto pela interface da Fluid

Evento - Trigger baseado em eventos do sistema

Agendamento - Execução programada via scheduler

Webhook externo - Chamada HTTP externa

Validação de Resposta

As respostas da API são validadas através de:

Status HTTP - Códigos de retorno padrão

Corpo da resposta - Estrutura JSON conforme documentação

Notas Técnicas

Protocolo: API REST

Formato: JSON

Autenticação: Token-based

Estrutura: Baseada em schemas oneOf para operações dinâmicas

Versionamento: Seguir documentação oficial para versões específicas

Suporte

Para dúvidas ou problemas com o conector:

Consulte a documentação oficial da API

Entre em contato com o suporte da Fluid

Verifique os logs de execução no painel de monitoramento