Documentação técnica da API


Objetivo da API

A API fornece acesso ao Atestado de Bons Antecedentes dos cidadãos Mineiros que possuam Registro Geral (RG), que estejam devidamente cadastrados na base de dados do Estado e que tenham autorizado a consulta via API.

Como obter acesso à API

A API é de acesso restrito. Para obter acesso, o parceiro deverá requisitar chave de acesso fornecida pela Prodemge. Mais informações através do e-mail api@prodemge.gov.br.

Lei Geral de Proteção de Dados Pessoais (LGPDP)

Em atendimento a Lei nº 13.709/2018 (Art 7º e Art 8 º), os dados pessoais do cidadão só poderão ser acessados mediante seu consentimento por meio que “demonstre a manifestação de vontade do titular expressa”.

Sendo assim, somente poderão ser acessados Atestados daqueles cidadãos que previamente autorizaram a consulta através do aplicativo de celular MGApp ou pelo site MG Cidadão utilizando sua conta pessoal.

É importante ressaltar que a autorização de acesso aos dados poderá ser revogada pelo cidadão a qualquer tempo, sem prévio aviso, através dos mesmos meios onde anteriormente o acesso foi autorizado.

Fluxo de autorização/desautorização de acesso aos dados


1.       O parceiro, através de sua aplicação (web / mobile etc) solicita os dados do cidadão ao ENDPOINT da API. Além dos parâmetros abaixo, todas as requisição devem conter no cabeçalho o “Authorization Bearer”, fornecido previamente pela Prodemge.

{
  "codigoSistema": "PRODEMGE",
  "cpf": "00000000000",
  "dataNascimento": "01/01/1991",
  "nomeCompleto": "Fulano",
  "nomeMae": "Mãe do Fulano",
  "codigoUnidade": 9999,
  "numeroRegistroGeral": 0
}

 

2.       Caso o cidadão ainda não possua conta no CIDADÃO MG ou ainda não tenha autorizado acesso ao Atestado de Bons Antecedentes, a API retornará mensagem de erro.

{
  "codigoMensagem": -1,
  "mensagem": "A consulta a esse servico não foi autorizada pelo usuário",
  "dataServidor": "24-10-2019 16:30:24"
}

 

3.       Caso a consulta ao Atesteado não esteja autorizada, o aplicativo parceiro deve redirecionar o cidadão para a tela de cadastro/login do CIDADÃO MG. A autorização de acesso ao Atestado de Bons Antecedentes do cidadão por terceiros é concedida neste sítio.

URL de redirecionamento: https://cidadao.mg.gov.br/?auth=true&des=Aprovar%20consulta%20bons%20antecedentes%20para%20NOME_AUTORIZACAO&cod=ANT_APROV&uni=COD_UNIDADE&cpf=01234567891
Parâmetros da URL

PARÂMETRO

OBRIGATÓRIO

EXEMPLO

DESCRIÇÃO

TIPO

Default

auth

Sim

 true

Valor fixo

Boolean

true

des

Sim

 Aprovar consulta de bons antecedentes?

Mensagem que o cidadão receberá no CIDADÃO MG que explica qual permissão está sendo concedida.

String

cod

Sim

 ANT_APROV

Código do dado a ser aprovado pelo cidadão, neste caso Atestado de Antecedentes.

Fornecido pela Prodemge.

String

uni

Sim

(código da unidade junto ao SSC fornecido pela PRODEMGE)

Identificador do parceiro. Fornecido pela Prodemge.

String

 

cpf

Sim

01234567891

CPF do cidadão a ser consultado.

double

 


Observação sobre a URL: Após montar a URL, todo o seu conteúdo, após o sinal de interrogação deve ser convertido para BASE64.
Ex: https://cidadao.mg.gov.br/?YXV0aD10cnVlJmRlcz1BcHJvdmFyJTIwY29uc3VsdGElMjBib25zJTIwYW50ZWNlZGVudGVzJTIwcGFyYSUyME5PTUVfQVVUT1JJWkFDQU8mY29kPUFOVF9BUFJPViZ1bmk9Q09EX1VOSURBREUmY3BmPTAxMjM0NTY3ODkx

4.       O cidadão, dentro do site do CIDADÃO MG autoriza o acesso ao serviço ANT_APROV (Atestado de Bons Antecedentes) em seu aparelho celular ou computador.

5.       Uma nova consulta deve ser realizada pelo aplicativo parceiro, com os mesmos parâmetros da primeira requisição.

6.       Desta vez, caso o Cidadão possua agora conta no CIDADÃO MG e tenha autorizado acesso ao Atestado de Bons Antecedentes, a API retornará mensagem com Atestado de Bons Antecedentes.

{
  "codigoMensagem": 1,
  "mensagem": "ATESTO que, nos termos do art. 20 do Código de Processo Penal, em pesquisa realizada nesta data, as 16:46, no sistema de informações policiais da Polícia Civil do Estado de Minas Gerais, não constam registro(s) de antecedente(s) em desfavor da pessoa acima qualificada.",
  "objeto": "S",
  "dataServidor": "2019-10-24 16:46:38"
}

7.       O Cidadão poderá retornar ao CIDADÃO MG ou acessar o Aplicativo MGAPP para celular e desautorizar a qualquer momento o acesso ao seu Atestado de Bons Antecedentes.

Endpoint

Consulta de Atestado de Bons Antecedentes

Parâmetros do endpoint

Deve ser enviado um POST para o endpoint com um JSON no corpo da requisição. A tabela detalha os parâmetros do objeto JSON.

PARÂMETRO

OBRIGATÓRIO

EXEMPLO

DESCRIÇÃO

TIPO

Default

codigoSistema

Sim

PRODEMGE

Código único por parceiro, fornecido pela PRODEMGE.

String


cpf

Sim

00011122200

CPF do cidadão a ser consultado.

Double


dataNascimento

Sim

20/12/1980

Data de nascimento do cidadão a ser consultado.

dd/mm/aaaa

0

nomeCompletoSimFulano de TalNome e sobrenome do cidadão a ser consultado.
CHAR(200)
nomeMaeNãoFulana de TalNome da mãe do consultado. Utilizado para fazer a desambiguação de homônimos, caso ocorra.
CHAR(200)
codigoUnidadeSim9999Valor fixo para controle interno da API. Fornecido pela PRODEMGE.INT(4)
numeroRegistroGeralSim11999818Número do RG do cidadão mineiro. Apenas RG de Minas Gerais podem ser consultados.INT(10)


Retorno: cidadão NÃO AUTORIZOU acesso ao Atestado de Bons Antecedentes

Por questões de sigilo e segurança, caso o cidadão não seja encontrado na base de dados, a mensagem de retorno é igual à mensagem de negativa de autorização para acesso ao Atestado de Bons Antecedentes.

OBJETO

VARIÁVEL

DESCRIÇÃO

TIPO

response

codigoMensagem

Identificador de erro (-1)

INT(1)

 

mensagem

Descrição do erro

String

dataServidor

Data/hora do servidor que forneceu o dado

DATAHORA


Retorno: cidadão AUTORIZOU previamente o acesso ao Atestado de Bons Antecedentes

OBJETO

VARIÁVEL

DESCRIÇÃO

TIPO

response

codigoMensagem

Identificador de sucesso (1)

INT(1)

 

mensagem

Texto do atestado de antecedentes.

String


objetoIndicador de bons antecedentes. S - Sim, N - NãoCHAR(1)

dataServidor

Data/hora do servidor que forneceu o dado

DATAHORA