{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"85398ee0-f0eb-475d-af33-4ca46933950f","name":"Web API do Sistema iiLex - Rotas Abertas","description":"_Atualizado em 22 de Dezembro de 2025 ás 09:52_\n\n# 📄 Começe por aqui!\n\nNesta documentação da API do Sistema iiLex, você descobrirá como buscar os dados de seus registros que estão no sistema.\n\nÉ crucial lembrar que esta documentação pressupõe a implementação completa do seu sistema iiLex, incluindo a configuração de seus módulos e seus campos. Sem essa configuração prévia e também a disponibilidade do sistema, as consultas mencionadas **não serão executadas com sucesso.**\n\nItens importantes:\n\n1. **Ambiente de Playground**: Não temos um ambiente de playground.\n    \n2. **Protocolo HTTPS**: Utilize sempre o protocolo HTTPS em suas requisições. Caso contrário, você receberá um erro 503.\n    \n3. **Rate e Limites de Uso**: Leia sobre os [Rate e Limites de Uso](#rate-e-limites-de-uso).  \n    **Plano Profissional:** Limite de até 60 requisições por minuto.**Plano Essential:** Limite de até 10 requisições por minuto.\n    \n4. **Regras e Configurações de Campos**: Regras, configurações de campos, automações, distribuições, vinculos, workflow e integrações não são chamadas nas requisições da API.\n    \n5. **Rotas Customizadas**: Se as rotas atuais não são úteis, você pode solicitar uma nova rota customizada ao nosso comercial.\n    \n\n# 🔑 Autenticação do V1\n\nPara fazer buscas, é necessário autenticar-se enviando o header `Authorization` com o esquema `Basic` e fornecendo o nome de usuário e senha.\n\nExemplo de header de autenticação:\n\nAUTHORIZATION Basic Auth\n\nAuthorization: Basic ABCDefgh1j2LM4NoPqRSTuVwXYZ=\n\n# 🚫 Resposta de erro de autenticação\n\nSe uma chave de API estiver ausente, malformada ou inválida, você receberá o código de resposta HTTP 401 Não Autorizado.\n\n``` json\n{\n    \"erro\": {\n        \"codigo\": 14,\n        \"mensagem\": \"Usuário não possui acesso ou não cadastrado.\",\n        \"detalhes\": \"Usuário não possui acesso ou não cadastrado.\"\n    }\n}\n\n ```\n\n---\n\n# 📑 Formato de Resposta\n\nTodos os retornos são feitos em JSON ou XML, dependendo do valor do header `Accept` enviado na requisição, utilize o header como desejar.\n\nExemplo de header `Accept`:\n\n``` bash\ncodeAccept: application/json\n\n ```\n\nou\n\n``` bash\ncodeAccept: application/xml\n\n ```\n\n# 🛡️ Rate e limites de uso\n\nimportante ressaltar que o uso da API irá competir com os usuários do seu sistema, portanto, evite abusos, pois advogados, estagiários e funcionários estão utilizando o mesmo sistema que você.\n\nObserve que as regras configuradas para os usuários via iiLex não afetarão a API. Por exemplo, um campo bloqueado na interface do usuário não será bloqueado na API e um campo obrigatório na interface do usuário não será obrigatório na API.\n\nEstamos elaborando todos os limites e termos de uso, mas por enquanto por favor não utilize formas automatizadas para fazer crawling, reqs em loop ou full scan dos dados da API. Lembre-se: Essa api não é um Data Lake.\n\nOs limites de taxa de acesso à API se aplicam ao usuário/chave de API em unidades de tempo. Os limites variam de acordo com o plano contratado:\n\n- **Plano Professional:** Limite de até **60 requisições por minuto**.\n    \n- **Plano Essential:** Limite de até **10 requisições por minuto**.\n    \n\nAtualmente, não há um limite mensal estabelecido. Se você exceder qualquer um desses limites, sua solicitação retornará um código de status **HTTP 429 Too Many Requests**.\n\nTodos os resultados são paginados. Para controlar a quantidade de registros retornados, utilize os parâmetros:\n\n- `pagina` → número da página desejada (começa em 0)\n    \n- `limite` → quantidade de registros por página (o limite máximo permitido é 500)\n    \n\n---\n\n### 📌 Exemplo de parâmetros de requisição\n\n```\nGET /endpoint?pagina=0&limite=20\n\n ```\n\n---\n\n### 📌 Exemplo de resposta\n\n``` json\n{\n  \"paginacao\": {\n    \"pagina_atual\": 0,\n    \"total_pagina_atual\": 2,\n    \"total_por_pagina\": 20,\n    \"total\": 2,\n    \"total_de_paginas\": 1\n  },\n  \"dados\": [\n    {\n      \"id\": 1,\n      \"nome\": \"Exemplo A\"\n    },\n    {\n      \"id\": 2,\n      \"nome\": \"Exemplo B\"\n    }\n  ]\n}\n\n ```\n\n---\n\n### 📖 Explicação dos campos de paginação\n\n- **`pagina_atual`** → número da página retornada (inicia em `0`)\n    \n- **`total_pagina_atual`** → quantidade de registros retornados na página atual\n    \n- **`total_por_pagina`** → limite definido na requisição (`limite`)\n    \n- **`total`** → quantidade total de registros encontrados na consulta\n    \n- **`total_de_paginas`** → número total de páginas disponíveis\n    \n\n# ❌ Erros comuns\n\n1- URI não existe.\n\n2- Erro ao encontrar módulos.\n\n3- Erro ao executar query de campos.\n\n4- Nenhum campomódulo encontrado.\n\n5- Parâmetro obrigatório.\n\n6- Página fora do intervalo.\n\n7- O número máximo de resultados por página é 500.\n\n8- Nenhum registro encontrado.\n\n9- Submódulo não encontrado.\n\n10- Tabela do submódulo não encontrada.\n\n11- Erro ao montar cláusula SELECT do submódulo.\n\n12- Módulo não encontrado.\n\n13- Módulo não permitido para busca\n\n14- Usuário não possui acesso ou não cadastrado.\n\n15- Banco de dados desconhecido\n\n16- Erro ao buscar registros.\n\n17- Módulo (ou submódulo) usado como filtro não encontrado.\n\n18- Parâmetros incorretos.\n\n19- Datas devem ser passada no formato Y-m-d.\n\n21- Nenhum tipo de andamento cadastrado para esse identificador.\n\n22- Erro de parse no XML.\n\n23- Módulo de Publicações não configurado.\n\n# 📃 Status comuns\n\n## Status 405 - Método não suportado\n\nUma resposta HTTP 405 dos nossos servidores indica que o método que está sendo utilizado pode estar incorreto para a requisição enviada, revise se ela é GET ou POST.\n\n**Utilize sempre https, não utilize os metodos de http.**\n\n## Status 404 - Not Found\n\nProvavélmente você está utilizando uma requisão que não existe, revise á variavel url se está preenchida corretamente ou se seu sistema está ativo.\n\n## Status 401 e 403 - Unauthorized e Forbbiden\n\nSignifica que não é permitido realizar esse request, seja por falta de permissão do usuário, ou não é permitido.\n\n## Status 503 - Serviço Indisponível\n\nUma resposta HTTP 503 dos nossos servidores indica que houve um pico inesperado no tráfego de acesso à API. O servidor geralmente volta a operar dentro dos próximos minutos. Se a interrupção persistir ou se você receber qualquer outra forma de erro HTTP 5XX, entre em contato com o suporte.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14108340","team":6175354,"collectionId":"85398ee0-f0eb-475d-af33-4ca46933950f","publishedId":"2sA3Bq4Avy","public":true,"publicUrl":"https://documenter-api.postman.tech/view/14108340/2sA3Bq4Avy","privateUrl":"https://go.postman.co/documentation/14108340-85398ee0-f0eb-475d-af33-4ca46933950f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.8","publishDate":"2024-04-24T18:02:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/518a4e604d2b866fdb926ee96c5607e681029300cb73ff6d4723c4db5b3a74bc","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3Bq4Avy"}