Integrações, API e avisos automáticos
- Quem tem acesso
- API e webhooks: Consultoria Escala. Avisos internos: todos os planos de consultoria
- Ver planos e preços
Antes de começar
- Ser o administrador da consultoria.
- Ter o plano Consultoria Escala ativo.
- Ter o segundo fator configurado em Segurança da conta (Configurar segundo fator).
Emitir um token da API de leitura
Preencha
Em Integrações e API, na área Emitir token de leitura, informe Nome da integração, Validade em dias (de 1 a 90) e marque em Permitir leitura de o que a integração pode ler (Clientes, Processos, Tarefas).
Emita
Marque a autorização e clique em Emitir token. Confirme o segundo fator quando pedido.
Guarde a chave
Clique em Copiar token e guarde num lugar seguro: ela aparece só agora. Depois clique em Já guardei a chave.
- Os tokens só leem dados, e só de clientes ativos.
- Até cinco tokens ativos; cada um faz até 60 consultas por minuto e 2.000 por dia.
- O link Documentação OpenAPI, na própria tela, descreve as consultas disponíveis.
- Para cortar o acesso, marque a confirmação e clique em Revogar token.
Avisos para outros sistemas (webhooks)
Crie o destino
Em Avisos para outros sistemas, abra Criar novo destino e informe Nome do destino, URL HTTPS e os Eventos compartilhados: Nova licitação na carteira, Alteração observada no PNCP, Alteração de processo, Alteração comercial ou Alteração no ERP.
Salve e guarde a chave
Clique em Salvar desativado com nova chave. Copie a chave de assinatura (ela não aparece de novo) e clique em Já guardei, ocultar chave.
Ative
Marque a autorização e clique em Ativar envios. Para parar, use Pausar envios.
- Até três destinos e 200 tentativas por dia para toda a consultoria, sem cobrança extra.
- O aviso leva só identificadores do evento, da empresa e do registro. Notas, contatos, documentos e valores financeiros não são enviados.
- Valide o cabeçalho X-Licitario-Assinatura (v1= seguido do HMAC-SHA256 de instante + "." + corpo) com a chave, usando o instante de X-Licitario-Instante. Use X-Licitario-Entrega para não processar a mesma entrega duas vezes.
- Há até seis tentativas automáticas em sete dias. Em Últimas entregas, Tentar novamente reenvia à mão.
Avisos automáticos dentro do Licitário
| Aviso | Onde ligar | Quem recebe |
|---|---|---|
| Resultado registrado ou corrigido | Avisos e compartilhamento › Salvar compartilhamento e avisos | A equipe e, se autorizado, os representantes do cliente (no máximo um aviso por processo, pessoa e dia) |
| Retorno de contato do CRM | Follow-up e lembretes › Salvar lembretes | O responsável pelo contato |
| Resumo diário do ERP (contratos, entregas, recebimentos e validade de documentos) | Prazos e pendências do ERP, em Avisos internos desta unidade › Salvar preferências | Administrador e funcionários, conforme o acesso de cada um |
| Documentos pedidos e enviados | Automático | Representantes do cliente e titular |
| Novas licitações das buscas dos clientes | Buscas e alertas deste cliente | O administrador, por e-mail ou WhatsApp |
Os avisos internos ficam no sino do Licitário. Para receber um lembrete fora da plataforma, cada pessoa abre Notificações, em Avisos da consultoria por e-mail e navegador marca Receber resumo diário por e-mail e/ou Receber lembrete diário no navegador e clica em Salvar meus canais da consultoria. Esse lembrete não inclui dados de clientes nem documentos.
Perguntas frequentes
- A API permite alterar dados?
- Não. Os tokens são só de leitura.
- Por que meu destino aparece como bloqueado?
- Os envios ficam bloqueados quando o plano Escala não está ativo ou o segundo fator do administrador não está configurado.
Veja também
Atualizado em 17/10/2026
Ainda com dúvida? Fale com a equipe