Documentação técnica da API
Objetivo da API
Esta API tem o objetivo de expor dados de compras realizadas
pelo Estado de Minas Gerais, bem como fornecedores e valores dos itens e
serviços adquiridos.
Para melhor entendimento do relacionamento entre os endpoints, considere o modelo:
Endpoins
Lista de fornecedores de Minas Gerais
Lista de empresas com contratos com o Governo do Estado de Minas Gerais. Todos os dados são extraídos do Portal de Compras - www.compras.mg.gov.br
Parâmetros do
endpoint
PARÂMETRO |
OBRIGATÓRIO |
EXEMPLO |
DESCRIÇÃO |
TIPO |
Default |
nome |
Não |
hospital |
O nome ou parte do nome do fornecedor a ser pesquisado. |
String |
null |
limite |
Não |
10 |
Quantidade máxima registros retornados. |
INT(3) |
100 |
offset |
Não |
10 |
O número de registros ignorados. Usado para paginação. |
INT(3) |
0 |
Retorno
OBJETO |
VARIÁVEL |
DESCRIÇÃO |
TIPO |
meta |
codigo |
Código HTTP de retorno da requisição |
INT(3) |
|
requestId |
Id interno que identifica a requisição ao endpoin |
CHAR(40) |
response |
idFornecedor |
Identificador interno |
INT(6) |
|
nrDocumento |
CNPJ do fornecedor. Sem máscara. |
DOUBLE(15) |
|
nomeFornecedor |
Nome do fornecedor no Portal de Compras do Estado de Minas Gerais. |
String |
Lista de materiais e serviços
Lista com todos os materiais e serviços fornecidos para o
Estado de Minas Gerais e que fazem parte do Portal de Compras.
Parâmetros do
endpoint
PARÂMETRO |
OBRIGATÓRIO |
EXEMPLO |
DESCRIÇÃO |
TIPO |
Default |
nome |
Não |
caixa |
O nome ou parte do nome do material a ser pesquisado. |
String |
null |
limite |
Não |
10 |
Quantidade máxima registros retornados. |
INT(3) |
100 |
offset |
Não |
10 |
O número de registros ignorados. Usado para paginação. |
INT(3) |
0 |
Retorno
OBJETO |
VARIÁVEL |
DESCRIÇÃO |
TIPO |
meta |
codigo |
Código HTTP de retorno da requisição |
INT(3) |
|
requestId |
Id interno que identifica a requisição ao endpoin |
CHAR(40) |
response |
idMaterialServico |
Identificador interno |
INT(5) |
|
cdMaterialServico |
Código do material no Portal de Compras |
INT(8) |
|
nomeMaterialServico |
Nome do material no Portal de Compras do Estado de Minas Gerais. |
String |
Lista de item / materiais e serviços
Lista com o detalhamento dos Materiais e Serviços, aqui
chamados de “Item / materiais e serviços”. Lista de todos os itens fornecidos
para o Estado de Minas Gerais e que fazem parte do Portal de Compras.
Parâmetros do
endpoint
PARÂMETRO |
OBRIGATÓRIO |
EXEMPLO |
DESCRIÇÃO |
TIPO |
Default |
nome |
Não |
caixa |
O nome ou parte do nome do item a ser pesquisado. |
String |
null |
limite |
Não |
10 |
Quantidade máxima registros retornados. |
INT(3) |
100 |
offset |
Não |
10 |
O número de registros ignorados. Usado para paginação. |
INT(3) |
0 |
Retorno
OBJETO |
VARIÁVEL |
DESCRIÇÃO |
TIPO |
meta |
Código |
Código HTTP de retorno da requisição |
INT(3) |
|
requestId |
Id interno que identifica a requisição ao endpoin |
CHAR(40) |
response |
idItemMaterialServico |
Identificador interno |
INT(6) |
|
cdItemMaterialServico |
Código do material no Portal de Compras |
INT(6) |
|
nomeItemMaterialServico |
Nome do item no Portal de Compras do Estado de Minas Gerais. |
String |
Lista de compras
Lista com todas as compras o Estado de Minas Gerais,
detalhamento do item da compra, fornecedor e valores.
Parâmetros do
endpoint
PARÂMETRO |
OBRIGATÓRIO |
EXEMPLO |
DESCRIÇÃO |
TIPO |
Default |
Nome |
Não |
caixa |
O nome ou parte do nome do materia a ser pesquisado. |
String |
null |
Limite |
Não |
10 |
Quantidade máxima registros retornados. |
INT(3) |
100 |
Offset |
Não |
10 |
O número de registros ignorados. Usado para paginação. |
INT(3) |
0 |
Ano |
Sim |
2019 |
Ano da realização da compra |
INT(4) |
|
idContratado |
Não |
100 |
Identificador interno do fornecedor (veja endpoint de fornecedores) |
INT(4) |
null |
idOrgaoDemanda |
Não |
VEJA TABELA DE ÓRGÃOS |
Identificador interno do órgão demandante* |
INT(7) |
null |
idMaterialServico |
Não |
10 |
Identificador interno do material/serviço (veja endpoint de materiais
e serviços) |
INT(5) |
null |
idItemMaterialServico |
Não |
100 |
Identificador interno do fornecedor (veja endpoint de item /materiais
e serviços) |
INT(6) |
null |
Retorno
OBJETO |
VARIÁVEL |
DESCRIÇÃO |
TIPO |
meta |
codigo |
Código HTTP de retorno da requisição |
INT(3) |
|
requestId |
Id interno que identifica a requisição ao endpoin |
CHAR(40) |
response |
nrDocumento |
CNPJ do fornecedor. Sem máscara. |
DOUBLE(15) |
|
nomeFornecedor |
Nome do fornecedor no Portal de Compras do Estado de Minas Gerais. |
String |
|
cdOrgao |
Código do órgão demandante* da compra no Portal de Compras. |
INT(6) |
|
nomeOrgao |
Nome do órgão no Portal de Compras do Estado de Minas Gerais. |
String |
|
nomeGrupoMaterialServico |
Agrupamento do material ou serviço contratado. |
String |
|
nomeClasseMaterialServico |
Classe do material ou serviço contratado. |
String |
|
nomeMaterialServico |
Nome do material ou serviço contratado. |
String |
|
cdItemMaterialServico |
Código do item de detalhamento do material ou serviço contratado no Portal
de Compras do Estado de Minas Gerais. |
INT(8) |
|
nomeItemMaterialServico |
Nome item de detalhamento do material ou serviço. |
String |
|
cdProcesso |
Código do processo de compra no Portal de Compras do Estado de Minas
Gerais. |
String |
|
objetoProcesso |
Descrição do objeto da compra |
String |
|
procedimentoProcesso |
Descrição do procedimento utilizado para a compra |
String |
|
elementoItem |
Emento item |
String |
|
naturezaDespesa |
Descrição da natureza da despesa do Estado. |
String |
|
unidadeOrcamentaria |
Descrição da unidade Orçamentária do Estado. |
String |
|
linhaFornecimento |
Descrição da linha de fornecimento. |
String |
|
dataHomologacao |
Data da homologação da compra |
DD/MM/AA |
|
cidadeEntrega |
Cidade/Estado onde a compra foi entregue. |
String |
|
qtdHomologada |
Quantidade homologada no processo de compra. |
FLOAT(10,2) |
|
unidadeMedida |
Unidade de medida do item de compra |
String |
|
valorReferenciaUnitario |
Valor de referência unitário para o item de compra. |
FLOAT(10,2) |
|
valorReferenciaTotal |
Valor de referência total para a compra. |
FLOAT(10,2) |
|
valorHomologadoUnitario |
Valor unitário homologado para o item de compra. |
FLOAT(10,2) |
|
valorHomologadoTotal |
Valor total homologado para a compra. |
FLOAT(10,2) |
|
nrContrato |
Número do contrato |
String |
|
urlContrato |
URL do contrato |
String |
Tabela de órgãos
IDORGAO |
CDORGAO |
NOME |
1831086 |
2230 |
ADMINISTRACAO DE ESTADIOS DE MINAS GERAIS |
1831099 |
1080 |
ADVOCACIA-GERAL DO ESTADO DE MINAS GERAIS |
1831072 |
2440 |
AG. REG. SERV. ABAST. AGUA E ESGOTAMENTO SANITARIO |
1831093 |
2430 |
AGENCIA DE DESENVOLVIMENTO DA RMBH |
1831013 |
2460 |
AGENCIA DE DESENVOLVIMENTO DA RMVA |
1831102 |
1010 |
ASSEMBLEIA LEGISLATIVA DO ESTADO DE MINAS GERAIS |
1831035 |
5200 |
BANCO DE DESENVOLVIMENTO DE MINAS GERAIS S.A. |
1831010 |
5070 |
CIA DE HABITACAO DO ESTADO DE MG LTDA - COHAB |
1831068 |
5140 |
CIA DE TECNOLOGIA DA INFORMACAO DO ESTADO DE MG |
1880424 |
5030 |
COMPANHIA DE DESENVOLVIMENTO DE MINAS GERAIS |
1878822 |
5020 |
COMPANHIA DE DESENVOLVIMENTO DE MINAS GERAIS_- INA |
1831107 |
5010 |
COMPANHIA DE DESENVOLVIMENTO ECONOMICO DE MG |
1831039 |
5240 |
COMPANHIA MINEIRA DE PROMOCOES - PROMINAS |
1831070 |
1520 |
CONTROLADORIA GERAL DO ESTADO DE MINAS GERAIS |
1831060 |
1340 |
COORDENADORIA DE APOIO E ASSIST. PESSOA DEFICIENTE |
1831009 |
1400 |
CORPO DE BOMBEIROS MILITAR DE MINAS GERAIS |
1831027 |
1440 |
DEFENSORIA PUBLICA DO ESTADO DE MINAS GERAIS |
1831084 |
2300 |
DEPARTAMENTO DE EDIFICACOES E ESTRADAS DE RODAGEM |
1831011 |
2140 |
DEPARTAMENTO DE OBRAS PUBLICAS DO ESTADO M.GERAIS |
1831076 |
2380 |
DEPARTAMENTO ESTADUAL DE TELECOMUNICACOES |
1831012 |
1940 |
EGE-SECRETARIA DE ESTADO DE PLANEJAMENTO E GESTAO |
1831045 |
3040 |
EMPRESA DE ASSIST. TECNICA E EXTENSAO RURAL DE MG |
1831029 |
3050 |
EMPRESA DE PESQUISA AGROPECUARIA DE MINAS GERAIS |
1831077 |
1910 |
ENCARGOS GERAIS DA SECRETARIA DE ESTADO DE FAZENDA |
1831071 |
1540 |
ESCOLA DE SAUDE PUBLICA DE MINAS GERAIS |
1831052 |
1600 |
ESCRITORIO DE PRIORIDADES ESTRATEGICAS |
1831048 |
1110 |
ESCRIT.REPRES. GOV. M.G EM BRASILIA |
1831074 |
1140 |
ESCRIT.REPRES.GOV DE M.G NO RIO |
1831061 |
1160 |
ESCRIT.REPRS.GOV. MG/SP |
1831038 |
2070 |
FUND. DE AMPARO A PESQ. DO ESTADO DE MINAS GERAIS |
1831016 |
2320 |
FUNDACAO CENTRO DE HEMATOLOGIA E HEMOTERAPIA DE MG |
1831049 |
2080 |
FUNDACAO CENTRO TECNOLOGICO DE MINAS GERAIS |
1831028 |
2180 |
FUNDACAO CLOVIS SALGADO |
1831062 |
2170 |
FUNDACAO DE ARTE DE OURO PRETO-FAOP |
1831104 |
2280 |
FUNDACAO DE EDUCACAO PARA TRABALHO DE MINAS GERAIS |
1831007 |
2160 |
FUNDACAO EDUCACIONAL CAIO MARTINS |
1831015 |
2090 |
FUNDACAO ESTADUAL DO MEIO AMBIENTE |
1831100 |
2260 |
FUNDACAO EZEQUIEL DIAS |
1831022 |
2150 |
FUNDACAO HELENA ANTIPOFF |
1831069 |
2450 |
FUNDACAO HIDROEX |
1831008 |
2270 |
FUNDACAO HOSPITALAR DO ESTADO DE MINAS GERAIS |
1831101 |
2060 |
FUNDACAO JOAO PINHEIRO |
1831089 |
2110 |
FUNDACAO RURAL MINEIRA - RURALMINAS |
1831085 |
2210 |
FUNDACAO TV MINAS CULTURAL E EDUCATIVA |
1831019 |
1070 |
GABINETE MILITAR DO GOVERNADOR DO ESTADO DE MG |
1877480 |
8030 |
H. RISOLETA NEVES |
1879523 |
8040 |
HM CELIO DE CASTRO |
1831088 |
2390 |
IMPRENSA OFICIAL DO ESTADO DE MINAS GERAIS |
1831042 |
2200 |
INST. EST. DO PATRIMONIO HIST. E ARTISTICO DE MG |
1831081 |
2010 |
INST.DE PREVIDENCIA DOS SERVIDORES DO EST.M.GERAIS |
1831075 |
5130 |
INSTITUTO DE DESENVOLVIMENTO INTEGRADO DE MG |
1831037 |
2420 |
INSTITUTO DE DESENVOLVIMENTO NORTE E NORDESTE MG |
1831063 |
2400 |
INSTITUTO DE GEOINFORMACAO E TECNOLOGIA (IGTEC) |
1831046 |
2330 |
INSTITUTO DE METROLOGIA E QUALIDADE DE MG |
1831082 |
2410 |
INSTITUTO DE TERRAS DO ESTADO DE MINAS GERAIS |
1831041 |
2100 |
INSTITUTO ESTADUAL DE FLORESTAS-IEF |
1831083 |
2370 |
INSTITUTO MINEIRO DE AGROPECUARIA |
1831066 |
2240 |
INSTITUTO MINEIRO DE GESTAO DAS AGUAS |
1831097 |
2120 |
INST.PREV.DOS SERV.MILITARES DO ESTADO M.GERAIS |
1831024 |
1560 |
INTENDENCIA DA CIDADE ADMINISTRATIVA |
1831032 |
2250 |
JUNTA COMERCIAL DO ESTADO DE MINAS GERAIS |
1831021 |
2040 |
LOTERIA DO ESTADO DE MINAS GERAIS |
1831026 |
5190 |
MGI - MINAS GERAIS PARICIPACOES |
1901707 |
5380 |
MINAS GERAIS ADMINISTRACAO E SERVICOS SA |
1831036 |
5330 |
MINAS GERAIS ADMINISTRACAO E SERVICOS S.A. - MGS |
1831055 |
1100 |
OUVIDORIA GERAL DO ESTADO |
1831079 |
1510 |
POLICIA CIVIL DO ESTADO DE MINAS GERAIS |
1831094 |
1250 |
POLICIA MILITAR DE MINAS GERAIS |
1833285 |
8100 |
PREFEITURA DE BELO HORIZONTE |
1831105 |
1090 |
PROCURADORIA GERAL DE JUSTICA |
1831087 |
3150 |
RADIO INCONFIDENCIA |
1831014 |
8020 |
SANTA CASA DE MISERICORDIA DE BELO HORIZONTE |
1831053 |
1650 |
SEC DE EST DE DIREITOS HUMANOS, PART.SOCIAL E CIDA |
1831054 |
1470 |
SEC. DE ESTADO DE CIDADES E DE INTEGRACAO REGIONAL |
1831040 |
1170 |
SEC. DE ESTADO DE RECURSOS HUMANOS E ADMINISTRACAO |
1831092 |
1220 |
SEC. EST. DESENV. ECO. CIENC. TEC. E ENS. SUPERIOR |
1831103 |
1230 |
SECRET. DE ESTADO DE AGRICULTURA, PECUARIA E ABAST |
1831018 |
1300 |
SECRET. DE ESTADO DE INFRAESTRUTURA E MOBILIDADE |
1831033 |
1570 |
SECRET. EST. CASA CIVIL E RELACOES INSTITUCIONAIS |
1831096 |
1190 |
SECRETARIA DE ESTADO DA FAZENDA |
1831017 |
1320 |
SECRETARIA DE ESTADO DA SAUDE |
1831047 |
1270 |
SECRETARIA DE ESTADO DE CULTURA E TURISMO |
1831090 |
1640 |
SECRETARIA DE ESTADO DE DESENVOLVIMENTO AGRARIO |
1831073 |
1460 |
SECRETARIA DE ESTADO DE DESENVOLVIMENTO ECONOMICO |
1831044 |
1260 |
SECRETARIA DE ESTADO DE EDUCACAO |
1831078 |
1670 |
SECRETARIA DE ESTADO DE ESPORTES |
1831050 |
1530 |
SECRETARIA DE ESTADO DE ESPORTES E JUVENTUDE |
1831031 |
1490 |
SECRETARIA DE ESTADO DE GOVERNO |
1831095 |
1450 |
SECRETARIA DE ESTADO DE JUSTICA E SEGURANCA PUBLIC |
1831065 |
1500 |
SECRETARIA DE ESTADO DE PLANEJAMENTO E GESTAO |
1831064 |
1690 |
SECRETARIA DE ESTADO DE SEGURANCA PUBLICA |
1831067 |
1480 |
SECRETARIA DE ESTADO DE TRABALHO E DESENVOLVIMENTO |
1831051 |
1580 |
SECRETARIA DE ESTADO DE TRABALHO E EMPREGO |
1831043 |
1410 |
SECRETARIA DE ESTADO DE TURISMO |
1831058 |
1370 |
SECRETARIA ESTADO DE MEIO AMB.DESENV SUSTENTAVEL |
1831023 |
1630 |
SECRETARIA GERAL |
1831025 |
1590 |
SEDINOR |
1831106 |
1700 |
S.E.EXTRA DE DESENVOL INTEGRADO E FORUNS REGIONAIS |
1831091 |
8010 |
SERVICO VOLUNTARIO DE ASSISTENCIA SOCIAL |
1831034 |
1030 |
TRIBUNAL DA JUSTICA DO ESTADO DE MINAS GERAIS |
1831020 |
1020 |
TRIBUNAL DE CONTAS DO ESTADO DE MINAS GERAIS |
1910409 |
1050 |
TRIBUNAL DE JUSTICA MILITAR DO ESTADO DE M.G. |
1831030 |
2350 |
UNIVERSIDADE DO ESTADO DE MINAS GERAIS |
1831059 |
2310 |
UNIVERSIDADE ESTADUAL DE MONTES CLAROS |
* O órgão demandante é aquele responsável pelo processo de
compra e não necessariamente o principal beneficiário dos itens ou serviços adquiridos.