PlugueJuris · API
Voltar ao painel

Documentação da API

Integre o PlugueJuris ao seu sistema: leia a conta do escritório, usuários, grupos de permissão e filiais, por uma API REST simples autenticada por chave.

Introdução

A API é REST, recebe e devolve JSON (UTF-8). Cada conta tem a sua própria chave de API, e todas as chamadas são escopadas por essa conta.

Você gera e encontra a chave no painel, em Conta → Plano → Chaves de API. Dica: cole a chave no campo à esquerda para os exemplos e o “Experimentar” já virem com ela.

Autenticação

Envie a chave em todas as requisições, de uma destas formas:


      

Nunca exponha a chave no navegador/app do usuário final. Trate-a como uma senha. Se vazar, gere outra no painel (e revogue a anterior).

Contrato OpenAPI & IA

A API tem um contrato OpenAPI 3 gerado automaticamente (sempre em dia com os endpoints abaixo). Use-o para importar no Postman, Insomnia, Swagger ou gerar um SDK.

Abrir openapi.json Baixar o arquivo

Vai integrar usando um assistente de IA? Baixe a doc em Markdown no padrão llms.txt — enxuta e pronta para colar no chat, com todos os endpoints, parâmetros e exemplos.

Abrir llms.txt Baixar para IA

URL base


      

Todos os caminhos de endpoint abaixo são relativos a essa base. Ex.: GET /usuarios → /usuarios.

Formato das respostas

Toda resposta traz um campo ok (booleano). Em caso de sucesso, vem ok: true junto com os dados. Em caso de erro, vem ok: false, um codigo estável e uma mensagem em erro, com o status HTTP adequado.

Sucesso

{ "ok": true, "usuarios": [ ... ] }

Erro

{ "ok": false, "codigo": "nao_encontrado", "erro": "Usuário não encontrado." }
StatusSignifica
200Sucesso (ok: true)
400Requisição inválida — faltou um campo ou valor incorreto
401Chave ausente (api_key_ausente) ou inválida (api_key_invalida)
403Fora do plano (fora_do_plano) — a API não está no plano da conta
404Recurso não encontrado
500Erro interno

Servidor MCP (para agentes de IA)

Além da REST, o PlugueJuris expõe um servidor MCP (Model Context Protocol) — conecte um agente de IA (Claude, etc.) e ele usa as mesmas ferramentas desta API. Autentica pela mesma chave da conta.

Adicionar no Claude Code


      

As ferramentas do MCP são as mesmas ações da API listadas abaixo.

Referência de endpoints

Carregando…