Portal do Integrador

Consulte os endpoints publicos e operacionais do Licitech

Este hub documenta as rotas que ja estao expostas pela aplicacao, com foco em integrações tecnicas, observabilidade e webhooks. O catalogo abaixo reflete o estado atual do sistema e pode ser revisado conforme novas interfaces HTTP forem liberadas.

Solicitar credenciais Ver catálogo de endpoints

Resumo rápido

  • Algumas rotas sao publicas; endpoints internos exigem sessao autenticada ou assinatura HMAC.
  • Catálogo agrupado por etapa da licitação com exemplos de payloads.
  • Documentação gerada automaticamente a partir do registro de endpoints.
  • SLA de retorno de 24h pelo núcleo de integrações.

Fluxo de uso para integradores

Use este portal para identificar quais rotas ja estao publicas, quais exigem sessao autenticada e quais dependem de assinatura tecnica, como o webhook do GitHub.

  1. Consulte o catalogo para identificar a rota e o metodo disponivel.
  2. Valide os requisitos de autenticacao, sessao ou assinatura indicados na documentacao.
  3. Se precisar ampliar o escopo, registre abaixo o caso de uso para avaliacao do time.

Ambientes disponíveis

Aplicacao Web

publico

Rotas HTTP expostas pelo servidor principal do Licitech.

/

60 chamadas por minuto

Operacoes Internas

interno

Rotas de verificacao tecnica consumidas por sessoes autenticadas e automacoes internas.

/

120 chamadas por minuto

Catálogo dinâmico de endpoints

O conteúdo abaixo é renderizado a partir do arquivo docs/api-endpoints.json e atualizado automaticamente pelo script npm run generate:api-docs.

Base path: /integracoes/apis

Endpoint Método Escopos Exemplo
Abrir hub de integracoes
Renderiza o portal com o catalogo de endpoints, ambientes e formulario de contato.
/integracoes/apis
 GET public:read 
curl -X GET http://localhost:3000/integracoes/apis
Registrar solicitacao de integracao
Recebe os dados do formulario de contato para analise do time responsavel.
/integracoes/apis
 POST public:read 
curl -X POST http://localhost:3000/integracoes/apis -H 'Content-Type: application/json' -d '{"company_name":"Prefeitura Exemplo","contact_name":"Maria Silva","email":"maria@prefeitura.gov.br","use_case":"Integrar painel interno com o hub publico.","environment":"sandbox","modules":["portal-integrador"]}'

Base path:

Endpoint Método Escopos Exemplo
Health check
Retorna status operacional simples do servidor para probes e monitoramento.
/health
 GET public:read 
curl -X GET http://localhost:3000/health
Verificacao de autorizacao da sessao
Retorna 204 quando a sessao do usuario segue valida e 401 quando a autenticacao nao existe ou expirou.
/ops/authz
 GET session:authz 
curl -i -X GET http://localhost:3000/ops/authz --cookie 'connect.sid=<sessao>'

Base path: /webhooks

Endpoint Método Escopos Exemplo
Status do sincronismo
Retorna o estado atual do fluxo de sincronismo de deploy.
/webhooks/status
 GET public:read 
curl -X GET http://localhost:3000/webhooks/status
Receber evento push do GitHub
Processa o webhook de push do branch principal, validando assinatura HMAC antes de executar o fluxo de sincronismo.
/webhooks/github
 POST webhook:github 
curl -X POST http://localhost:3000/webhooks/github -H 'Content-Type: application/json' -H 'x-hub-signature-256: sha256=<assinatura>' -d '{"ref":"refs/heads/master"}'

Eventos de webhook

Utilize webhooks para ser avisado automaticamente sobre mudanças relevantes. Configure o endpoint via API e valide a assinatura com o segredo informado no cadastro.

github.push

Evento recebido em `/webhooks/github` quando o branch principal publica um novo push autorizado.

Webhook 
{
  "ref": "refs/heads/master",
  "repository": {
    "full_name": "org/licitech"
  },
  "head_commit": {
    "id": "abc123def456",
    "message": "Atualiza deploy"
  }
}

Cabeçalhos obrigatórios

Inclua os cabeçalhos abaixo em todas as chamadas autenticadas.

  • Cookie Sessao autenticada obrigatoria para rotas internas protegidas por login.
  • x-hub-signature-256 Assinatura HMAC obrigatoria no webhook de GitHub.

Solicite acesso à API

Preencha as informações abaixo para que possamos liberar o ambiente de sandbox. Entraremos em contato em até 24 horas através do e-mail informado.

Acompanhamento de pedidos

Mantemos um histórico dos últimos pedidos para que a equipe de integrações valide fluxos recorrentes.

Nenhuma solicitação registrada até o momento.