API Reference · Controladoria Jurídica
Situação dos contratos
A CJUR não é mais a API consumida diretamente pelo Hub. Ela publica eventos para a Function. A Function tem contrato técnico de entrada e de saída, mas a compatibilidade e a publicação das operações correspondentes no nead-hub-api dependem da issue #212. Nenhuma operação desta página autoriza a interface do Hub a chamar a CJUR ou a Function diretamente.
POST · endpoint da Function no Appwrite
Finalidade: receber uma publicação da CJUR para tratamento.
Autenticação e autorização: a CJUR assina o corpo bruto com HMAC-SHA256. A Function verifica a assinatura em tempo constante e recusa instante fora da janela de cinco minutos. O endereço público concreto da Function é uma configuração de ambiente e não está definido como rota do Hub.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Cabeçalho | x-lsa-evento | texto | Sim | Chave de idempotência do evento. |
| Cabeçalho | x-lsa-tipo | texto | Sim | Tipo do evento. |
| Cabeçalho | x-lsa-versao | texto | Sim | Versão do envelope. |
| Cabeçalho | x-lsa-instante | epoch em segundos | Sim | Deve estar dentro da janela anti-replay. |
| Cabeçalho | x-lsa-tentativa | texto | Sim | Tentativa de entrega. |
| Cabeçalho | x-lsa-assinatura | texto | Sim | Valor sha256 do HMAC. |
| Corpo | v | inteiro | Sim | Versão do envelope. |
| Corpo | seq | texto | Sim | Sequência publicada pela CJUR. |
| Corpo | id | texto | Sim | Identidade do evento. |
| Corpo | escopo | texto | Sim | Escopo do evento. |
| Corpo | tipo | texto | Sim | Tipo do evento. |
| Corpo | ocorrido_em | data e hora | Sim | Instante do fato. |
| Corpo | corpo | objeto | Sim | Conteúdo específico do evento. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 2xx | — | sem corpo definido | Evento processado, duplicado ou ignorado. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | — | Corpo inválido; a CJUR não deve reenviar. |
| 401 | — | Assinatura inválida. |
| 5xx | — | Falha transitória; a CJUR pode reenviar. |
PUT · /v1/integracoes/cjur/processos/{cnj}/sentenca
Situação: contrato de saída definido pela Function para o nead-hub-api. A publicação e a compatibilidade da rota no nead-hub-api devem ser confirmadas na issue #212.
Finalidade: registrar a sentença classificada pela Function para um processo identificado por CNJ.
Autenticação e autorização: token de serviço da Function, com escopo de escrita de sentença. A requisição leva chave de idempotência estável por movimentação.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | cnj | texto | Sim | Número CNJ do processo. |
| Cabeçalho | Authorization | Bearer token | Sim | Credencial de serviço. |
| Cabeçalho | Idempotency-Key | texto | Sim | Chave estável da movimentação. |
| Corpo | tipo | texto | Sim | Tipo de sentença classificado. |
| Corpo | origem | texto | Sim | Origem da classificação. |
| Corpo | codigo_nacional | inteiro | Não | Código nacional quando aplicável. |
| Corpo | movimentacao_id | texto | Sim | Movimento de origem. |
| Corpo | ocorrida_em | data e hora | Sim | Base da precedência. |
| Corpo | evento_cjur_id | texto | Sim | Evento que originou o efeito. |
| Corpo | versao_regra | texto | Sim | Versão da regra aplicada. |
Saída
| HTTP | Campo | Tipo | Descrição | | --- | --- | --- | | 200 | aplicado | booleano | Indica se a sentença recebida se tornou vigente. | | 200 | motivo | texto ou nulo | Replay ou sentença não mais recente, quando aplicável. | | 200 | sentenca | objeto | Sentença vigente depois da operação. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Caminho, chave ou corpo inválido. |
| 401 | UNAUTHORIZED | Credencial ausente, inválida, revogada ou expirada. |
| 403 | FORBIDDEN | Credencial sem sistema ou escopo necessário. |
| 404 | NOT_FOUND | Processo não localizado pelo CNJ. |
| 409 | CONFLICT | Conflito de chave ou CNJ ambíguo. |
| 429 | RATE_LIMITED | Limite de taxa. |
| 5xx | — | Falha transitória da API do Hub. |
POST · /v1/integracoes/cjur/tratamentos
Situação: contrato de saída definido pela Function para o nead-hub-api. A publicação e a compatibilidade da rota no nead-hub-api devem ser confirmadas na issue #212.
Finalidade: registrar um resultado de classificação, atribuição, distribuição ou aviso.
Autenticação e autorização: token de serviço da Function com escopo de escrita de tratamentos e chave de idempotência da etapa.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Cabeçalho | Authorization | Bearer token | Sim | Credencial de serviço. |
| Cabeçalho | Idempotency-Key | texto | Sim | Chave formada pela etapa, evento e versão principal. |
| Corpo | evento_cjur_id | texto | Sim | Evento de origem. |
| Corpo | etapa | texto | Sim | Classificação, atribuição, distribuição ou aviso. |
| Corpo | cnj | texto ou nulo | Sim | Número CNJ quando conhecido. |
| Corpo | estado | texto | Sim | Estado produzido pela etapa. |
| Corpo | resultado | objeto | Sim | Resultado sem dados pessoais. |
| Corpo | versoes | objeto | Sim | Versões aplicadas ao tratamento. |
| Corpo | simulado | booleano | Sim | Indica execução simulada. |
Saída
| HTTP | Campo | Tipo | Descrição | | --- | --- | --- | | 201 | aplicado | booleano | Primeiro registro da chave. | | 200 | aplicado | booleano | Replay idempotente da mesma chave e corpo. | | 200 ou 201 | tratamento | objeto | Tratamento conservado pela API. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Corpo, chave ou dados pessoais não permitidos. |
| 401 | UNAUTHORIZED | Credencial ausente, inválida, revogada ou expirada. |
| 403 | FORBIDDEN | Credencial sem sistema ou escopo necessário. |
| 409 | CONFLICT | Chave reutilizada com conteúdo diferente. |
| 429 | RATE_LIMITED | Limite de taxa. |
| 5xx | — | Falha transitória da API do Hub. |
Pendências
- Publicar e validar, na API do Hub, os contratos que esta página registra como contratos da Function.
- Definir as leituras que alimentam a Visão Geral.
- Definir operações de Configurações por proprietário e comando.
- Confirmar a superfície que o Hub consumirá após a adequação da issue #212.