API de Integração

Conecte seus sistemas ao New Ledger IA. Disponível no plano Enterprise.

Baixar especificação OpenAPI — importe no Postman ou gere um cliente na sua linguagem.

Visão geral

A API de integração do New Ledger IA permite que sistemas próprios (ERPs, portais internos) consultem e acionem operações do seu escritório de forma programática.

A autenticação é por API key com escopos (scopes), e todo acesso é isolado por organização — uma chave só enxerga os dados da org à qual pertence.

Autenticação

Gere uma API key na plataforma (Configurações → Chaves de API). A chave tem o prefixo nlk_ e é exibida uma única vez — guarde-a com segurança.

Envie a chave no cabeçalho Authorization de cada requisição:

Authorization: Bearer nlk_suachave

Base URL e formato

Todas as chamadas usam a base https://api.newledgererp.com.br. O gateway de integração expõe um manifesto de ferramentas e um endpoint de execução por ferramenta.

Respostas e erros são JSON. Chaves revogadas ou expiradas retornam 401; sem permissão para a org, 403.

Limites

As requisições são limitadas por IP (rate limiting). Em caso de excesso, a API responde 429 — implemente retry com backoff no seu integrador.

A API está em evolução (v0.1). Endpoints atuais são estáveis; novos serão adicionados de forma retrocompatível.

Endpoints

GET/mcp/manifest

Lista as ferramentas (tools) disponíveis e seus parâmetros.

curl https://api.newledgererp.com.br/mcp/manifest \
  -H "Authorization: Bearer nlk_suachave"

POST/mcp/call/consultar_titulos_abertos

Lista títulos a pagar/receber em aberto de uma empresa.

curl -X POST https://api.newledgererp.com.br/mcp/call/consultar_titulos_abertos \
  -H "Authorization: Bearer nlk_suachave" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "UUID", "empresaId": "UUID" }'

POST/mcp/call/executar_match_automatico

Dispara a conciliação bancária automática em background.

curl -X POST https://api.newledgererp.com.br/mcp/call/executar_match_automatico \
  -H "Authorization: Bearer nlk_suachave" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "UUID", "empresaId": "UUID" }'

Dúvidas de integração? contato@newledgererp.com.br