Objetivo da API

Esta API manipulaos dados sobre consignação de servidores públicos, militares e pensionistas.

Como obter acesso à API

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

Todas as requisiçõesdevem conter no cabeçalho o “Authorization: Bearer” com a chave de acessofornecida.

Endpoints

Margem de consignação

Verifica se um determinado CPF (apenas servidores públicos do Estado de Minas Gerias) possui margem de consignação em folha disponível para empréstimo.

Dado um CPF eo valor mensal desejado para o empréstimo consignado, obtém-se aresposta se o valor informado está ou não dentro da margem de consignaçãodisponível (atualmente 10% para cartão de crédito, 30% para empréstimo e 60%para financiamento imobiliário).

Parâmetros doendpoint

Retorno

Averbação de empréstimos

Averba (confirma) ocontrato entre o Consignatário (instituição financeira) e o Consignante (Estado).

Uma vez averbado oempréstimo, o desconto em folha iniciará no mês e ano informados.

Parâmetros doendpoint

Retorno

Cancelamento de empréstimos

Informa ao consignatárioo cancelamento do empréstimo firmado com a instituição financeira. Assim, ovalor consignado não será mais debitado em folha.

Parâmetros doendpoint

Retorno

Renovação de empréstimos

Renova um ou vários contratos entre o Consignatário (instituição financeira) e o Consignante (Estado).

Uma vez averbado o empréstimo, o desconto em folha iniciará no mês e ano informados.

Parâmetros do endpoint

PARÂMETRO	OBRIGATÓRIO	EXEMPLO	DESCRIÇÃO	TIPO	Default
codigoConsignatario	Sim	26	Código do Consignatário no sistema Consig-web.	INT(10)	n/a
codigoConsignante	Sim	1501	Código do órgão Consignante no sistema Consig-web. Ver tabela de consignantes.	INT(10)	n/a
idContrato	Sim	3213131	Identificador do Contrato do empréstimo. Interno do consignatário.	CHAR(20)	n/a
cpf	Sim	02114895653	CPF do servidor, pensionista ou militar	DOUBLE	n/a
mesAnoCarencia	Sim	112019	Mês Ano de Carência de início do envio do empréstimo. Formato MMYYYY	INT(6)	n/a
matricula	Sim	2117919	Matrícula do servidor, pensionista ou militar. No caso do IPSEMG, deve ser informado o Número do Processo.	INT(10)	n/a
numeroIpsemg	Sim	0	Número do IPSEMG. Informar somente para o consignante IPSEMG, caso contrário informar “0”.	INT(10)	n/a
valorSolicitado	Sim	1000.50	Valor solicitado (valor depositado)	DOUBLE(10,2)	n/a
valorTotalFinanciado	Sim	1105.00	Valor total financiado	DOUBLE(10,2)	n/a
valorParcela	Sim	110.50	Valor da parcela	DOUBLE(10,2)	n/a
totalDeParcelas	Sim	10	Total de parcelas do contrato em R$	INT(3)	n/a
cet	Sim	1.30	Custo efetivo total	DOUBLE(10,2)	n/a
taxaDeJuros	Sim	2.30	Taxa de Juros	DOUBLE(10,2)	n/a
formaDeContratacao	Sim	WEB	Forma de contratação: WEB, ADF ou TAA	CHAR(3)	n/a
idContratosARenovar	Sim	[ “123”, “456”, “678”]	Array com Identificadores dos Contratos a serem renovados.	ARRAY de CHAR(20)	n/a

 

Retorno

OBJETO	VARIÁVEL	DESCRIÇÃO	TIPO
	error	Indica se ocorreu algum erro ao executar a pesquisa.	BOOLEAN
	nome	Nome do Servidor	String
	matricula	Matrícula do consignante	INT(10)
	numeroIpsemg	Número do IPSEMG. Informar somente para o consignante IPSEMG, caso contrário informar “0”.	INT(10)
	valorAverbado	Valor averbado da parcela.	DOUBLE(10,2)
	idContratoAverbado	Identificador do Contrato do empréstimo averbado	INT(10)
	mesAnoCarencia	Mês/Ano de Carência de início do envio do empréstimo. Formato MMYYYY	INT(6)
	dataInsercao	Hora da transação.	DATETIME DD-MM-AAAA HH:II:SS
retorno	codigo	Código e mensagem de retorno da consulta. “000” indica sucesso.	INT(3)
	mensagem	Mensagem detalhada do erro, se houver.	String

 

Tabela de Consignantes