API — visão geral

O LIP oferece uma API HTTP para que outros sistemas e automações enviem notificações à sua organização. É assim que um evento em outro sistema (uma nota rejeitada, um processo concluído, um alerta) vira uma notificação para quem assina o canal correspondente.

Endereço base

Todas as chamadas usam o endereço da sua instância:

https://suaorganizacao.lip.lbhm.com.br

Autenticação

As chamadas de API são autenticadas por uma chave de API, enviada no cabeçalho Authorization:

Authorization: Bearer SUA_CHAVE

Gerando uma chave

Um administrador do LIP gera as chaves na tela Chaves de API:

  1. Clique em Nova chave e dê um nome ao consumidor (ex.: “automação de faturamento”).
  2. Copie a chave na hora — por segurança, ela é exibida uma única vez.
  3. Guarde a chave no sistema que fará as chamadas.

Uma chave pode ser revogada a qualquer momento na mesma tela; a partir daí ela para de funcionar.

Formato

  • As requisições enviam e recebem JSON (Content-Type: application/json).
  • Respostas de sucesso usam códigos 2xx; erros usam 4xx com um campo error.

Veja Enviar notificações para o endpoint e exemplos.