A API de documentos do Themis (V1) permite o envio, consulta e atualização de documentos vinculados a processos e desdobramentos cadastrados no sistema.
Por meio dela, é possível armazenar arquivos de forma estruturada e recuperá-los posteriormente para utilização em integrações, automações e rotinas documentais.
Os documentos são transmitidos em formato Base64 e podem ser associados a diferentes entidades do sistema, como processos, despesas e desdobramentos.
Além disso, a API disponibiliza recursos para listar documentos vinculados a um processo específico e consultar informações detalhadas de arquivos já cadastrados, facilitando o gerenciamento centralizado da documentação jurídica e administrativa.
‼️Importante: Esta documentação refere-se à API de documentos V1. Atualmente, o Themis disponibiliza uma versão mais moderna da API de documentos, com recursos e arquitetura atualizados para novas integrações.
A API de Documentos V2 está disponível a partir da versão 4.16.5.1 do Themis.
Para utilizá-la, é necessário que o ambiente esteja atualizado para essa versão ou superior. Caso sua instalação esteja em uma versão anterior, recomendamos agendar a atualização do sistema antes de iniciar uma nova integração.
Limitações da API
Antes de utilizar os métodos disponíveis, observe as seguintes restrições:
O campo nomeArquivo é limitado em 120 caracteres.
O campo nomeArquivoOrigem é limitado em 99 caracteres.
Caracteres especiais ou espaços não são aceitos.
Os campos de id devem enviar obrigatoriamente números inteiros.
Para inserir ou editar um arquivo binário é necessário codificá-lo em Base64.
Inserir documento
Path: /api/documentos/novo/json
Método: POST
Inserir documento base64.
JSON enviado (exemplo):
{
"nomeArquivo":"teste",
"descricao":"descricao teste",
"numero":"612",
"tipo":{
"id":4
},
"dominio":{
"id":1
},
"nomeArquivoOrigem":"teste.txt",
"formato":0,
"despesa":{
"id":140
},
"processo":{
"id":26
},
"desdobramento":{
"id":158
},
"arquivo":"ARQUIVO EM BYTES BASE64*"
}
Editar documento
Path: /api/documentos/edita/json
Método: POST
Editar documento.
JSON enviado (exemplo):
{
"id":"8",
"nomeArquivo":"teste",
"descricao":"descricao teste",
"numero":"612",
"tipo":{
"id":4
},
"dominio":{
"id":1
},
"nomeArquivoOrigem":"teste.txt",
"formato":0,
"desdobramento":{
"id":158
},
"arquivo":"ARQUIVO EM BYTES BASE64*"
}
Listar documentos de um processo
Path: /api/documentos/processo/{idProcesso}/jsonMétodo: GET
Lista todos os documentos de um processo específico.
JSON retornado (exemplo):
[
{
"id": 511,
"nomeArquivo": "sdfsdf",
"nomeArquivoOrigem": "438-xtgjp.gif",
"descricao": "sdfsdfsfd",
"numero": "123",
"tamanho": "0,03MB",
"dataCadastro": "30/06/2017",
"data": "08/06/2017",
"tipo": {
"id": 13,
"nome": "pbcylxghbmmcdljtuhgfwrggqqoaatlmrrsrtwcvwbpfydtvkp"
},
"resumoProcesso": "01 - Ambiental - Abilio Soares - A Verificar3 x Andréia Mezenga - 1234.5678.987.91983",
"idDesdobramento": 15693,
"idAdvogado": 2,
"nomeAdvogado": "Anita Coimbra do Nascimento"
},
{
"id": 512,
"nomeArquivo": "fdfdhgddf",
"nomeArquivoOrigem": "450-jyedb.gif",
"descricao": "dgfjghkjhjhkjhgk",
"numero": "123456789",
"tamanho": "0,03MB",
"dataCadastro": "30/06/2017",
"data": "28/06/2017",
"tipo": {
"id": 15,
"nome": "jrdoqlwvkvmibuyavvuzakuewyvprqxiwduejbcywydpkorjjz"
},
"resumoProcesso": "01 - Ambiental - Abilio Soares - A Verificar3 x Andréia Mezenga - 1234.5678.987.91983",
"idDesdobramento": 15693,
"idAdvogado": 3,
"nomeAdvogado": "Gilberto da Silveira"
}
]
Retorna documento específico
Path: /api/documentos/{idDocumento}/jsonMétodo: GET
Retorna as informações de um documento específico.
JSON retornado (exemplo):
{
"id": 514,
"nomeArquivo": "sdfgsdf",
"nomeArquivoOrigem": "443-uicjc.gif",
"descricao": "dfgdfg dfgdfg",
"numero": "123456789",
"tamanho": "0,03MB",
"dataCadastro": "30/06/2017",
"data": "07/06/2017",
"tipo": {
"id": 15,
"nome": "jrdoqlwvkvmibuyavvuzakuewyvprqxiwduejbcywydpkorjjz"
},
"resumoProcesso": "01 - Ambiental - Abilio Soares - A Verificar3 x Andréia Mezenga - 1234.5678.987.91983",
"idDesdobramento": 15693,
"idAdvogado": 3,
"nomeAdvogado": "Gilberto da Silveira",
"arquivo": "ARQUVIO BASE64*"
}
Ficou com alguma dúvida? Entre em contato com nosso time de suporte pelo e-mail suporte@aurum.com.br ou, se preferir, utilize o ícone de chat disponível diretamente no Themis. Estamos à disposição para ajudar.
Estes artigos podem interessar a você: