Remessa Digital - Resposta da Carta
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 uma resposta da carta, 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.
O evento a ser cadastrado no serviço de Notificações do CNJ é "CartaRespondida".
Ao processar a notificação, obtêm os metadados da resposta da carta 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/20256000000000019
Response:
{
"protocolo": "20256000000000019",
"documentos": [
{
"id": 14083,
"ordem": 0,
"idDocumentoPai": null,
"urlConteudo": "https://repositorio.stg.pdpj.jus.br/portal?hash=e0",
"tipoDocumento": {
"codigo": "746",
"descricao": "Citatória (746)"
},
"dataHora": "02/06/2025 13:47:46",
"nome": "PDF-A.pdf",
"descricao": "principal",
"mimeType": "application/pdf",
"principal": true,
"nivelSigilo": 1,
"tamanho": 170506,
"hash": "e0",
"cadeiaCertificado": "MI",
"assinatura": "Hh"
},
{
"id": 14084,
"ordem": 0,
"idDocumentoPai": null,
"urlConteudo": "https://repositorio.stg.pdpj.jus.br/portal?hash=b3",
"tipoDocumento": {
"codigo": "586",
"descricao": "Informação (586)"
},
"dataHora": "02/06/2025 13:47:46",
"nome": "14858 - Associado de Negócios - 7 vagas (Home Based) Application (2).pdf",
"descricao": "anexo",
"mimeType": "application/pdf",
"principal": false,
"nivelSigilo": 1,
"tamanho": 21370,
"hash": "b3",
"cadeiaCertificado": "MI",
"assinatura": "OH"
},
{
"id": 14088,
"ordem": 0,
"idDocumentoPai": null,
"urlConteudo": "https://repositorio.stg.pdpj.jus.br/portal?hash=21",
"tipoDocumento": {
"codigo": "80",
"descricao": "Outros Documentos"
},
"dataHora": "02/06/2025 14:54:51",
"nome": "protocoloCartaOrdem_20251000000000097",
"descricao": "Recibo CNJ",
"mimeType": "application/pdf",
"principal": false,
"nivelSigilo": 0,
"tamanho": 0,
"hash": "21",
"cadeiaCertificado": "MI",
"assinatura": "h/"
},
{
"id": 14285,
"ordem": 0,
"idDocumentoPai": null,
"urlConteudo": "https://repositorio.stg.pdpj.jus.br/portal?hash=e0",
"tipoDocumento": {
"codigo": "653",
"descricao": "Ofício Enviando Informações (653)"
},
"dataHora": "03/06/2025 11:54:00",
"nome": "PDF-A",
"descricao": "principal",
"mimeType": "application/pdf",
"principal": true,
"nivelSigilo": 1,
"tamanho": 170506,
"hash": "e0",
"cadeiaCertificado": "MI",
"assinatura": "Hh"
},
{
"id": 14286,
"ordem": 0,
"idDocumentoPai": null,
"urlConteudo": "https://repositorio.stg.pdpj.jus.br/portal?hash=b3",
"tipoDocumento": {
"codigo": "14458",
"descricao": "Certidão - Ausência de Manifestação do Exequente (14458)"
},
"dataHora": "03/06/2025 11:54:00",
"nome": "protocoloPeticao_20254000000002563.pdf",
"descricao": "anexo",
"mimeType": "application/pdf",
"principal": false,
"nivelSigilo": 1,
"tamanho": 95642,
"hash": "b3",
"cadeiaCertificado": "MI",
"assinatura": "Nz"
}
],
"dataEnvio": "02/06/2025 13:48:01",
"numeroProcesso": "0000000-84.2022.8.12.0000",
"idAvisoExpediente": null,
"cpfPeticionante": "12345678900",
"nomePeticionante": "FERNANDO",
"tipoPeticao": "1",
"idOrigemTipoDocumento": 1,
"processoOrigem": "0000000-91.2013.8.12.0000",
"segmentoJusticaOrigem": "812",
"tribunalOrigem": "Tribunal de Justiça do Estado de Mato Grosso do Sul",
"grauOrigem": "GRA1E",
"orgaoTribunalOrigem": "CORONEL SAPUCAIA - VARA ÚNICA",
"situacaoResposta": "PARCIALMENTE_CUMPRIDA"
}
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'.
O atributo “resultado” conterá o resultado da resposta da carta: CUMPRIDA, NAO_CUMPRIDA, PARCIALMENTE_CUMPRIDA.
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 - Complemento
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 resposta da carta 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ÓDIGO | DESCRIÇÃO | OBSERVAÇÃO |
|---|---|---|
| 14596 | Devolução de Ofício | Tipo de documento do arquivo principal da resposta da carta |
| 654 | Ofício (Outros) | Tipo de documento do arquivo principal da resposta da carta |
| 651 | Ofício Comunicando Decisões | Tipo de documento do arquivo principal da resposta da carta |
| 652 | Ofício Enviando Acórdão | Tipo de documento do arquivo principal da resposta da carta |
| 653 | Ofício Enviando Informações | Tipo de documento do arquivo principal da resposta da carta |
| 655 | Ofício Solicitando Informações | Tipo de documento do arquivo principal da resposta da carta |
| 656 | Ofício Solicitando Peças | Tipo de documento do arquivo principal da resposta da carta |
| 650 | Ofício-Circular | Tipo de documento do arquivo principal da resposta da carta |
| 14597 | Recebimento de Ofício | Tipo de documento do arquivo principal da resposta da carta |
| 15432 | Recibo de Protocolo do Portal de Serviços do CNJ | Tipo de documento do recibo da resposta da carta |
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 - Complemento
| CÓDIGO | DESCRIÇÃO | OBSERVAÇÃO |
|---|---|---|
| 79 | Ofício | Tipo de documento do arquivo principal da resposta da carta |
| 80 | Outros documentos | Tipo de documento dos arquivos anexos e do recibo da resposta da carta |
Para maiores informações sobre os códigos dos complementos do tipo de documento, veja: https://www.cnj.jus.br/sgt/gerenciar_complementos.php