Pular para o conteúdo

Processos

Esta seção é para escritórios e sistemas parceiros que acompanham processos de um cliente do Xjur e querem manter o Xjur atualizado automaticamente, sem digitação: cada novo andamento, audiência, sentença ou alteração de valores no sistema do escritório é enviado ao Xjur pelo XJUR Connect.

Quero…Vá para
Encontrar o processo pelo número CNJLocalizar o processo
Registrar andamentos (movimentações, publicações, juntadas)Andamentos
Agendar, redesignar e informar o resultado de audiênciasAudiências
Registrar sentençasSentenças
Informar o valor da causa e os pedidos, com valores e riscoValores
Entender um erro devolvido pela APICódigos de Erro
Testar as rotas de forma interativaReferência da API
ConceitoO que é
ProcessoProcesso do contencioso cadastrado no Xjur pelo cliente. A integração não cria processos: alimenta os que já existem
Número do processoNúmero CNJ (0009101-11.2026.8.26.0100), com ou sem máscara. O número de um desdobramento (recurso, incidente) também encontra o processo principal
processoIdId do processo no Xjur. Devolvido por GET /processo; pode ser guardado para as chamadas seguintes
CatálogosListas do Xjur usadas pelos campos (tipos de andamento, tipos de audiência, tipos de pedido, riscos…). Aceitam o id ou o nome exato
CódigoIdentificador do registro no sistema do escritório. É a chave de rastreio e de idempotência
FluxoRegras de trabalho do cliente no Xjur. Um novo andamento, audiência ou sentença pode gerar tarefas (compromissos) para a equipe do cliente
flowchart LR
  A["POST /Autenticacao/AuthenticateUserService"] --> P["GET /processo?numeroProcesso="]
  K["GET /processo/catalogos/{catalogo}"] --> AN
  P --> AN["POST /processo/andamentos"]
  P --> AU["POST /processo/audiencias"]
  P --> S["POST /processo/sentencas"]
  P --> V["PUT /processo/valor-causa<br/>POST /processo/pedidos"]
  AU --> AUP["PATCH /processo/audiencias/{id}"]
  1. Configure uma vez: consulte os catálogos e mapeie os tipos do seu sistema para os do Xjur.
  2. Localize o processo pelo número CNJ — ou envie o numeroProcesso direto em cada chamada.
  3. Envie cada novidade com um codigo do seu sistema.
GET /processo?numeroProcesso=0009101-11.2026.8.26.0100 HTTP/1.1
Authorization: Bearer <token>
X-XJUR-SUBSCRIPTION-KEY: <subscription-key>
{
"processoId": 748610,
"numeroProcesso": "0009101-11.2026.8.26.0100",
"numerosDesdobramentos": [],
"pasta": "2026/000123",
"areaDireito": "Cível",
"status": "Ativo",
"uf": "SP",
"cidade": "São Paulo",
"escritorio": "Silva & Associados",
"partesContrarias": [
{ "nome": "João da Silva", "documento": "123.456.789-09", "formaParticipacao": "Autor" }
]
}

Também é possível consultar por id: GET /processo/{processoId}.

Em todas as rotas de escrita e listagem, o processo é informado de uma das formas:

CampoDescrição
processoIdId do processo no Xjur (mais rápido)
numeroProcessoNúmero CNJ, com ou sem máscara

Quando os dois vêm, vale o processoId.

GET /processo/catalogos/tipos-andamento?nome=juntada HTTP/1.1
{
"totalPaginas": 1,
"totalRegistros": 2,
"data": [
{ "id": 12, "nome": "Juntada de Petição", "codigo": null },
{ "id": 57, "nome": "Juntada de AR", "codigo": null }
]
}
CatálogoUsado em
tipos-andamentotipoAndamentoId do andamento
tipos-audienciatipoAudienciaId da audiência
status-audienciastatusAudienciaId da audiência
resultados-audienciaresultadoAudienciaId da audiência
tipos-decisaotipoDecisaoId da sentença
tipos-pedidotipoPedidoId do pedido
riscosriscoId do pedido

Parâmetros: nome (contém), pagina (a partir de 1) e limite (padrão 50, máximo 200). Só itens ativos.

Em vez do id, os payloads aceitam o nome exato (tipoAndamento, tipoAudiencia, risco…), sem distinção de maiúsculas e acentos. O id é mais rápido e não quebra se o nome mudar — prefira mapear ids na configuração da integração.

Toda criação aceita um codigo — o id do registro no seu sistema (até 100 caracteres). Se a mesma criação for reenviada com o mesmo codigo para o mesmo processo (retry depois de timeout, reprocessamento de fila), o registro existente é devolvido com 200 e jaExistia: true, sem duplicar.

Sem codigo não há essa proteção: cada chamada cria um registro novo.

MétodoRotaDescriçãoDocumentação
GET/processoLocaliza o processo pelo número CNJ ou idacima
GET/processo/{processoId}Consulta o processo pelo idacima
GET/processo/catalogos/{catalogo}Ids e nomes aceitos pelos camposacima
POST/processo/andamentosRegistra um andamentoAndamentos
GET/processo/andamentosLista os andamentos do processoAndamentos
DELETE/processo/andamentos/{andamentoId}Descarta um andamentoAndamentos
POST/processo/audienciasAgenda uma audiênciaAudiências
GET/processo/audienciasLista as audiências do processoAudiências
PATCH/processo/audiencias/{audienciaId}Redesigna, informa resultado, altera dadosAudiências
POST/processo/sentencasRegistra uma sentençaSentenças
GET/processo/sentencasLista as sentenças do processoSentenças
PATCH/processo/sentencas/{sentencaId}Atualiza uma sentençaSentenças
PUT/processo/valor-causaAtualiza o valor da causaValores
POST/processo/pedidosCadastra um pedido com valores e riscoValores
GET/processo/pedidosLista os pedidos do processoValores
PATCH/processo/pedidos/{pedidoId}Atualiza valores ou risco de um pedidoValores
DELETE/processo/pedidos/{pedidoId}Exclui um pedidoValores
  • Token JWT de usuário de serviço obtido em POST /Autenticacao/AuthenticateUserService (veja Autenticação). Para escritórios, o recomendado é um usuário vinculado ao escritório, que só enxerga os processos dele
  • Subscription key (X-XJUR-SUBSCRIPTION-KEY)
  • Permissões do usuário de serviço no perfil:
MóduloPermissõesPara
ContenciosoLeitura, Atualização, EscritaLocalizar o processo, valor da causa e pedidos
AndamentosLeitura, Escrita, ExclusãoAndamentos (Exclusão só para descartar)
AudiênciasLeitura, Escrita, AtualizaçãoAudiências
DecisõesLeitura, Escrita, AtualizaçãoSentenças
AdministraçãoLeituraCatálogos
AmbienteURL Base
Produçãohttps://apim-xjur-prd.xjur.com.br/connect
Homologaçãohttps://apim-xjur-qa.xjur.com.br/connect