Pular para o conteúdo principal

Remessa Digital - Ofícios

dica

A Documentação/Swagger do Portal de Serviços Interno se encontra disponível em https://portal-interno-api-tribunais.stg.pdpj.jus.br/swagger-ui.html

O link para acesso ao Portal de Serviços Interno, no ambiente de homologação é https://portal-interno-tribunais.stg.pdpj.jus.br/.



Ao protocolizar um ofício, o Tribunal irá receber a mensagem acima no formato de notificação, no endpoint de webhook configurado por ele no serviços de notificações da PDPJ. Recomenda-se checar a documentação do serviço em https://docs.pdpj.jus.br/notificacoes.

atenção

O evento a ser cadastrado no serviço de Notificações do CNJ é "OficioEncaminhado".


Ao processar a notificação, obtêm os metadados do ofício e dos documentos por meio de uma requisição GET na url informada no payload. Ao realizar as requisições aos endpoints indicados na notificação, o sistema do tribunal deve adicionar no cabeçalho HTTP Authorization um bearer token que deve ser obtido por meio do SSO da PDPJ. O access token deve ser de serviço, ou seja, utilizando o client_id do sistema do tribunal e grant_type do tipo client_credentials. Para entender melhor, vide https://docs.pdpj.jus.br/servicos-estruturantes/autenticacao-sso.


Exemplo da resposta ao chamar o endpoint contido no campo url da mensagem recebida do serviço de notificações:

GET https://portal-interno-api-tribunais.stg.pdpj.jus.br/api/v1/peticoes/por-protocolo/20252000000000111

Response:

{   
"protocolo":"20252000000000111",   
"documentos":[{         
    "id":4887,         
    "ordem":0,         
    "idDocumentoPai":null,        
    "urlConteudo":"https://repositorio.stg.pdpj.jus.br/portal?hash=3404eb22474b211b7c405b7ac6f36a7d9533f92b",         
    "tipoDocumento":
    {            
        "codigo":"655",            
        "descricao":"Ofício Solicitando Informações"         
    },         
    "dataHora":"18/02/2025 12:36:29",         
    "nome":"Juntada_de_Docs.pdf",         
    "descricao":"Juntada_de_Docs",         
    "mimeType":"application/pdf",         
    "principal":true,        
    "nivelSigilo":0,         
    "tamanho":719065,         
    "hash":"3404eb22474b211b7c405b7ac6f36a7d9533f92b",         
    "cadeiaCertificado":"MIIbb...",         
    "assinatura":"WI45y..."      
    },      
    {         
    "id":4911,         
    "ordem":1,         
    "idDocumentoPai":null,        
    "urlConteudo":"https://repositorio.stg.pdpj.jus.br/portal?hash=C1BAF91DC398FF8D33D426D4FEDE4611A671A422",         
    "tipoDocumento":
    {            
        "codigo":"15432",            
        "descricao":"Recibo de Protocolo do Portal de Serviços do CNJ"         
    },         
    "dataHora":"18/02/2025 15:13:38",         
    "nome":"Recibo_protocolo_nº_20252000000000111",         
    "descricao":"Recibo CNJ",         
    "mimeType":"application/pdf",         
    "principal":false,         
    "nivelSigilo":0,         
    "tamanho":0,         
    "hash":"C1BAF91DC398FF8D33D426D4FEDE4611A671A422",         
    "cadeiaCertificado":"MI...",         
    "assinatura":"Um/m+..."     
}],   
"dataEnvio":"18/02/2025 15:13:34",   
"numeroProcesso":"0800038-96.2024.8.19.0045",   
"idAvisoExpediente":null,   
"cpfPeticionante":"12345678900",   
"nomePeticionante":"Fulano da Silva",   
"tipoPeticao":"79",   
"idOrigemTipoDocumento":1
}
info

O atributo “idOrigemTipoDocumento” conterá o código do documento utilizado pelo tribunal: 1 - TPU; 2 - Tabela própria; 3 - Complemento 'tipo_de_documento'. O atributo “tipoPeticao” conterá o código do complemento 'tipo_de_documento'.

Para maiores informações sobre os códigos de documento, veja:

Anexo I - Listagem dos códigos de documento (Interno) - TPU
Anexo II - Listagem dos códigos de documento (Interno) - Complemento 'tipo_de_documento'

Ao requisitar a URL em urlConteudo, o sistema do tribunal receberá uma resposta 302 (REDIRECT), contendo a URL pré-assinada temporária para download do arquivo.

A maioria dos clientes HTTP utilizados pelas linguagens de mercado tratam esse cenário de forma transparente, não sendo necessário, via de regra, qualquer implementação específica por parte do sistema do tribunal.

Processada a juntada, o sistema do tribunal então chama a URL constante em callback, na mensagem recebida do serviço de notificações:

POST https://portal-interno-api-tribunais.stg.pdpj.jus.br/api/v1/protocolos/20252000000000111/callback

{   
"protocoloPortal": "20252000000000111",   
"protocolo": "XYZ123456789", //valor gerado pelo sistema do tribunal se retornar sucesso true   
"dataHora": "18/02/2025 18:13:40",   
"sucesso": true,  //true em caso de sucesso e false em caso de erro   
"erros": [] //se retornar sucesso false, informar lista de strings aqui, com mensagens de erro
}

O sistema do tribunal deve receber um código "HTTP 200 OK" ao chamar o endpoint acima, indicando sucesso na operação de atualização do status do protocolo no Portal de Serviços. Feito isso, o sistema exibirá ao servidor logado o status do protocolo (se a juntada do ofício ocorreu com sucesso ou não, no sistema do tribunal).

Autenticação/autorização​

A API utiliza o Single Sign On (Keycloak) do CNJ para autenticar os endpoints. A autorização dependerá do perfil do usuário (servidor ou magistrado), conforme, se for o caso, o que constar no sistema CNJ Corporativo.

Veja mais em https://docs.pdpj.jus.br/servicos-estruturantes/autenticacao-sso

Anexo I - Listagem dos códigos de documento (Interno) - TPU​

CÓDIGODESCRIÇÃOOBSERVAÇÃO
14596Devolução de OfícioTipo de documento do arquivo principal do ofício
654Ofício (Outros)Tipo de documento do arquivo principal do ofício
651Ofício Comunicando DecisõesTipo de documento do arquivo principal do ofício
652Ofício Enviando AcórdãoTipo de documento do arquivo principal do ofício
653Ofício Enviando InformaçõesTipo de documento do arquivo principal do ofício
655Ofício Solicitando InformaçõesTipo de documento do arquivo principal do ofício
656Ofício Solicitando PeçasTipo de documento do arquivo principal do ofício
650Ofício-CircularTipo de documento do arquivo principal do ofício
14597Recebimento de OfícioTipo de documento do arquivo principal do ofício
15432Recibo de Protocolo do Portal de Serviços do CNJTipo de documento do recibo do ofício
info

Para os anexos, serão considerados os documentos (último nível) da hierarquia de Internos (2) da TPU. Para maiores informações sobre os códigos dos documentos da TPU, veja https://www.cnj.jus.br/sgt/consulta_publica_documentos.php

Anexo II - Listagem dos códigos de documento (Interno) - Complemento 'tipo_de_documento'​

CÓDIGODESCRIÇÃOOBSERVAÇÃO
79OfícioAtributo “tipoPeticao” / tipo de documento do arquivo principal do ofício
163Ofício - Descumprimento de Medida Protetiva (Lei Maria da Penha)Atributo “tipoPeticao” / tipo de documento do arquivo principal do ofício
80Outros documentosTipo de documento dos arquivos anexos e do recibo do ofício