Mudanças entre as edições de "API - Cartórios"

De Wiki CTI
Ir para: navegação, pesquisa
(Como consumir as APIs disponibilizadas)
(Como consumir as APIs disponibilizadas)
Linha 37: Linha 37:
  
 
==Como consumir as APIs disponibilizadas==
 
==Como consumir as APIs disponibilizadas==
Inicialmente todos os cartórios serão cadastrados como um sistema consumidor dentro do sistema gerenciador de acessos do TJMT, os ambientes são:
 
 
* Ambiente de homologação: (https://cerberus-hom.tjmt.jus.br)
 
 
Este cadastro é realizado pela equipe do Poder Judiciário por meio de pedido via SDM (https://sdm.tjmt.jus.br). Neste pedido, deve ser informado quais scopes deverão ser permitidos, estes estão descritos em cada API.
 
 
Após o cadastramento dos cartórios, o consumo da API deverá ser realizado via autorização concedida pelo sistema de geração de tokens do PJMT, utilizando as credenciais geradas para cada consumidor: <br /> <br />
 
  
 
'''Ambientes para geração dos tokens de acesso'''
 
'''Ambientes para geração dos tokens de acesso'''

Edição das 12h30min de 15 de agosto de 2022

logosdk
Endereço: https://hellsgate-rc.tjmt.jus.br/
Inicio Homologação: 01/08/2022
Equipe responsável: Equipe Administrativa
Linguagem: C#
Autenticação: IDP / Cerberus

Proposta

Realizar a interligação dos sistemas de gestão dos cartórios com a base de dados gerida pelo Poder Judiciário de Mato Grosso por meio de webservices e API's, com o objetivo de consolidar as informações de forma automatizada permitindo a extração de relatórios e demonstrativos conforme prevê a Resolução N. 389 de 29/04/2021, Resolução N. 215 de 16 de dezembro de 2015 e Lei N. 12.527 de 18 de novembro de 2011. Tal projeto foi viabilizado por intermédio do Processo Administrativo nr. 0021787-73.2021.811.0000.

Estão previstas a coleta de dados relacionados ao:

  • Livro diário auxiliar,
  • Livro de depósito prévio;
  • Auto-correição;
  • Envio de lotes ao tribunal e pedido de selos.



Como consumir as APIs disponibilizadas

Ambientes para geração dos tokens de acesso

Na fase de homologação utilizar as seguintes credenciais para gerar o token de acesso:

  • client_id:2515
  • client_secret:secret
  • scope:gif_pedido_selo_api
  • grant_type:client_credentials

O sistema consumidor deverá gerar um access_token (por meio de um flow da especificação) que será enviada no cabeçalho (header) como "Authorization: Bearer {acces_token}" em toda requisição à API.
A solicitação do access_token deve ser feita informando os scopes (exemplo: https://brandur.org/oauth-scope) necessários para consumir a API desejada.

APIs disponibilizadas

Pedido de Selo

scope: gif_pedido_selo_api

Parâmetros de Entrada via POST

Entrada Legenda
"cns": "string" Deve receber o Código Nacional de Serventias, formato "00.000-0"
"cpf": "string" CPF do requisitante do selo sem máscara, esta pessoa deve estar cadastrada no sistema GIF no menu Cadastro Geral // Preposto.
"quantidadeSeloDigital": "int" Número inteiro de 1 a 99999999.

Regras

  • Devem ser informados CNSs e CPFs válidos.
  • As credenciais informadas no pedido devem corresponder com dados de pessoas vinculadas à serventia do CNS informado, ou seja, o pedido só pode ser realizado para o cartório se o CPF informado corresponder a uma pessoa cadastrada na base de prepostos do referido cartório.
  • As pessoas são cadastradas no sistema GIF no meu Cadastro Geral // Prepostos.


Resposta da API de Pedido de Selo

Response Legenda
"urlGuiaPagamento": "https://hellsgate-rc.tjmt.jus.br/gif-selo-api/guia/reimpressao-guia/NrUnicoGuiaGerada" URL para impressão da guia de recolhimento referente a compra do selo.
"Protocolo": "F0DE2810-DAC6-4C57-8E5D-FAG3FD5DFD0D" Número do protocolo do pedido de selo registrado, este protocolo será a chave de entrada para a consulta e obtenção do lote de selos com pagamento confirmado.
"QuantidadePedido": "XXX" Quantidade adquirida.
"QuantidadeCreditos": "XXX" Quantidade de créditos recebidos nesta aquisição de selos.

Consultar lote de selo


Parâmetros de Entrada

Entrada Legenda
"Protocolo": "F0DE2810-DAC6-4C57-8E5D-FAG3FD5DFD0D" Número de protocolo recebido no registro do pedido de selo."
"cpf": "string" CPF de quem está recebendo o lote de selos, apenas números, esta pessoa deve estar cadastrada no sistema GIF no menu Cadastro Geral // Preposto.

Regras

  • Devem ser informados CPFs e Protocolos válidos.
  • O CPF informado deve corresponder a uma pessoa cadastrada na base de prepostos do referido cartório, a identificação do cartório será através do Protocolo informado.


Resposta da API de Consulta de Lote de Selo

Response Legenda
"SituacaoPedido": "1,2,3..." 1 - Lançado; 2 - Enviado para o fornecedor de selos; 3 - Enviado para a Serventia; 4 - Recebido pela Serventia (AR); 5 - Pagamento de Guia Confirmado; 6 - Selo Digital Recebido; 7 - Lançado - Aguardando Pagamento; 8 - Em Espera. Enviar após dia 01/08/2010; 9 - Cancelado.
"LoteSelo":

"Protocolo:"
"DataPedido:"
"Quantidade:"
"Selos:"

Dados do pedido contendo a sequência alfanumérica de selos gerada.