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.
Por onde começar
Seção intitulada “Por onde começar”| Quero… | Vá para |
|---|---|
| Encontrar o processo pelo número CNJ | Localizar o processo |
| Registrar andamentos (movimentações, publicações, juntadas) | Andamentos |
| Agendar, redesignar e informar o resultado de audiências | Audiências |
| Registrar sentenças | Sentenças |
| Informar o valor da causa e os pedidos, com valores e risco | Valores |
| Entender um erro devolvido pela API | Códigos de Erro |
| Testar as rotas de forma interativa | Referência da API |
Conceitos
Seção intitulada “Conceitos”| Conceito | O que é |
|---|---|
| Processo | Processo do contencioso cadastrado no Xjur pelo cliente. A integração não cria processos: alimenta os que já existem |
| Número do processo | Nú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 |
| processoId | Id do processo no Xjur. Devolvido por GET /processo; pode ser guardado para as chamadas seguintes |
| Catálogos | Listas do Xjur usadas pelos campos (tipos de andamento, tipos de audiência, tipos de pedido, riscos…). Aceitam o id ou o nome exato |
| Código | Identificador do registro no sistema do escritório. É a chave de rastreio e de idempotência |
| Fluxo | Regras de trabalho do cliente no Xjur. Um novo andamento, audiência ou sentença pode gerar tarefas (compromissos) para a equipe do cliente |
Como as peças se encaixam
Seção intitulada “Como as peças se encaixam”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}"] - Configure uma vez: consulte os catálogos e mapeie os tipos do seu sistema para os do Xjur.
- Localize o processo pelo número CNJ — ou envie o
numeroProcessodireto em cada chamada. - Envie cada novidade com um
codigodo seu sistema.
Localizar o processo
Seção intitulada “Localizar o processo”GET /processo?numeroProcesso=0009101-11.2026.8.26.0100 HTTP/1.1Authorization: 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:
| Campo | Descrição |
|---|---|
processoId | Id do processo no Xjur (mais rápido) |
numeroProcesso | Número CNJ, com ou sem máscara |
Quando os dois vêm, vale o processoId.
Catálogos
Seção intitulada “Catálogos”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álogo | Usado em |
|---|---|
tipos-andamento | tipoAndamentoId do andamento |
tipos-audiencia | tipoAudienciaId da audiência |
status-audiencia | statusAudienciaId da audiência |
resultados-audiencia | resultadoAudienciaId da audiência |
tipos-decisao | tipoDecisaoId da sentença |
tipos-pedido | tipoPedidoId do pedido |
riscos | riscoId 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.
Idempotência
Seção intitulada “Idempotência”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.
Endpoints
Seção intitulada “Endpoints”| Método | Rota | Descrição | Documentação |
|---|---|---|---|
GET | /processo | Localiza o processo pelo número CNJ ou id | acima |
GET | /processo/{processoId} | Consulta o processo pelo id | acima |
GET | /processo/catalogos/{catalogo} | Ids e nomes aceitos pelos campos | acima |
POST | /processo/andamentos | Registra um andamento | Andamentos |
GET | /processo/andamentos | Lista os andamentos do processo | Andamentos |
DELETE | /processo/andamentos/{andamentoId} | Descarta um andamento | Andamentos |
POST | /processo/audiencias | Agenda uma audiência | Audiências |
GET | /processo/audiencias | Lista as audiências do processo | Audiências |
PATCH | /processo/audiencias/{audienciaId} | Redesigna, informa resultado, altera dados | Audiências |
POST | /processo/sentencas | Registra uma sentença | Sentenças |
GET | /processo/sentencas | Lista as sentenças do processo | Sentenças |
PATCH | /processo/sentencas/{sentencaId} | Atualiza uma sentença | Sentenças |
PUT | /processo/valor-causa | Atualiza o valor da causa | Valores |
POST | /processo/pedidos | Cadastra um pedido com valores e risco | Valores |
GET | /processo/pedidos | Lista os pedidos do processo | Valores |
PATCH | /processo/pedidos/{pedidoId} | Atualiza valores ou risco de um pedido | Valores |
DELETE | /processo/pedidos/{pedidoId} | Exclui um pedido | Valores |
Pré-requisitos
Seção intitulada “Pré-requisitos”- 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ódulo | Permissões | Para |
|---|---|---|
| Contencioso | Leitura, Atualização, Escrita | Localizar o processo, valor da causa e pedidos |
| Andamentos | Leitura, Escrita, Exclusão | Andamentos (Exclusão só para descartar) |
| Audiências | Leitura, Escrita, Atualização | Audiências |
| Decisões | Leitura, Escrita, Atualização | Sentenças |
| Administração | Leitura | Catálogos |
Ambientes
Seção intitulada “Ambientes”| Ambiente | URL Base |
|---|---|
| Produção | https://apim-xjur-prd.xjur.com.br/connect |
| Homologação | https://apim-xjur-qa.xjur.com.br/connect |