API

Interface de Programação de Aplicativos

API é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma baseado na Web.

Em um mundo cada vez mais digital e conectado, todo mundo já usou, mesmo sem saber uma API. A sigla vem do inglês Application Programming Interface, uma API permite que aconteça troca de informações entre dois ou mais sistemas é como se fosse uma ponte ligando esses sistemas.

Uma API é basicamente uma programação que contém um conjunto de instruções que controlam o funcionamento de um computador, site ou aplicação transmitindo a outro dispositivo ou site essa informação de forma automática. Através de uma API podem ser construídos a comunicação entre sites, ferramentas e widgets como os aplicativos de celular.

A API é o que roda “por trás” dos programas, fazendo com que aplicativos conversem uns com os outros sem que seja necessária uma intervenção humana, automatizando os processos. Enquanto o usuário tem acesso apenas à interface — o site, o app ou o programa —, nos bastidores muitos aplicativos estão trabalhando em conjunto utilizando APIs.

DADOS ABERTOS

Segundo a Open Defnition (opendefnition.org): “dado aberto é um dado que pode ser livremente utilizado, reutilizado e redistribuído por qualquer um”, com a única exigência de creditar a sua autoria. Se resumem em alguns pontos importantes:

Disponibilidade e acesso: o dado precisa estar disponível por inteiro e por um custo razoável de reprodução, preferencialmente por meio de download na Internet; também deve estar num formato conveniente e modificável.

Reuso e redistribuição: o dado precisa ser fornecido em condições que permitam reutilização e redistribuição, incluindo o cruzamento com outros conjuntos de dados.

Participação universal: todos podem usar, reutilizar e redistribuir, não havendo discriminação contra áreas de atuação, pessoas ou grupos (não são permitidas restrições como “não comercial”, que impedem o uso comercial, e restrições de uso para certos fins, como “somente educacional”).

URL

Descrição da utilização da URL para acesso aos dados abertos.

https://fapspmg.es.gov.br/dados-abertos/base/formato/filtro/ano/mês.html

base: Base de dados que será utilizada para gerar o arquivo de saída. Este parâmetro é obrigatório.

formato: Formato do arquivo de saída, que pode ser utilizado através de download ou interpretado por qualquer linguagem de programação. Veja a baixo os formatos disponíveis. Este parâmetro é obrigatório.

filtro: Filtro para restrição de registros.

ano: Registros relativos ao ano informado aqui. Este parâmetro pode ser opcional ou obrigatório dependendo do formato de saída. Confira esta informação na página específica de cada formato.

mês: Registros relativos ao mês informado aqui. Este parâmetro é opcional.

EXEMPLO DE COMO USAR A URL

https://fapspmg.es.gov.br/dados-abertos/licitacao/json/-/2020/12.html

FORMATOS DISPONÍVEIS

JSON

É um formato de arquivo bem fácil de ser interpretado por qualquer linguagem de programação, ou seja, costuma ser mais fácil para os computadores processarem JSON do que outras linguagens, como o XML.

Exemplo de saída do arquivo.

[
   {
      "protocolo": "#2015.0804.1658.8867",
      "resumo_do_pedido": "Médicos atuando no município",
      "data_do_pedido": "2015-08-04 16:58:00",
      "data_de_arquivamento": "2015-09-17 01:09:00",
      "quantidade_de_prorrogacoes": "0",
      "houve_recurso": "Não",
      "houve_reclamacao": "Não",
      "pedido_respondido": "Sim",
      "orgao": "AP - Area Publica",
      "orgao_email": "contato@gmail.com",
      "categoria_do_pedido": "Serviço da saúde",
      "ano": "2015",
      "mes": "08",
      "link": "http://www.dominio.com.br/e-sic/detalhe/2015-0804-1658-8867.html"
   },
   ...
]


Exemplo de saída do arquivo com ERRO.

{
   "erro": true,
   "mensagem": "Mensagem de erro",
   "link": "Endereço URL da API para tirar dúvidas"
}

XML

É um formato amplamente usado para troca de dados, pois possibilita que se mantenha a estrutura dos dados em operações diferentes. O modo como os arquivos XML são construídos permite escrever parte da documentação dentro dos dados, sem interferir na sua leitura.

CSV

É um formato compacto e, portanto, adequado para transferir grandes conjuntos de dados com uma mesma estrutura.

TXT

É um formato compacto com os campos separados por ";" e, portanto, adequado para transferir grandes conjuntos de dados com uma mesma estrutura. Documentos de texto puro (TXT) são muito fáceis de serem lidos por computadores.

PDF

Os PDFs costumam ser usados para circulação interna de documentos, já que não permitem modificação (são somente leitura) e por manterem a diagramação original do conteúdo.

HTML

Atualmente, muitos dados estão disponíveis em formato HTML em vários sítios governamentais. Isso pode ser sufciente, já que os dados em HTML são muito estáveis e têm escopo limitado. Em alguns casos, é preferível ter os dados em um formato mais fácil de ser baixado e manipulado, com custo baixo e a facilidade de linkar em website.

e-SIC

Sistema Eletrônico do Serviço de Informações ao Cidadão



URL DA API

https://fapspmg.es.gov.br/dados-abertos/base/formato/filtro/ano/mes.html



EXEMPLO DE COMO USAR A URL

Descrição da utilização da URL para acesso aos dados abertos. Para os formatos disponíveis, não há limite de registros para o retorno da informação.

base: e-SIC.

formato: Disponível em JSON, CSV, TXT, HTML, XML e PDF.

filtro: Situação.

ano: Registros relativos ao ano informado aqui. Este parâmetro é obrigatório.

mês: Registros relativos ao mês informado aqui. Este parâmetro é opcional.


1: https://fapspmg.es.gov.br/dados-abertos/e-sic/json/1/2020.html - Serão exibidos todos os registros cuja situação corresponda ao ID 1 e ano de 2020.

2: https://fapspmg.es.gov.br/dados-abertos/e-sic/json/-/2020/12.html - Serão exibidos todos os registros de qualquer situação e que corresponda ao ano de 2020 e mês 12.



SITUAÇÃO

IDCAMPO
-Todos os registros
4Não conhecimento
5Negado
7Parcialmente Atendido
10Atendido


TODOS AS SITUAÇÃOES

https://fapspmg.es.gov.br/dados-abertos/e-sic/json/situacao.html

https://fapspmg.es.gov.br/dados-abertos/e-sic/json/situacao.html



CAMPOS DE RETORNO

CAMPOTIPODESCRIÇÃO
solicitacao_idintegerID do registro
solicitacao_protocolostringProtocolo do pedido de informação
solicitacao_resumostringResumo do pedido
solicitacao_prorrogacaointegerQuantidade de prorrogações sofridas pelo pedido
solicitacao_tempo_atendimentointegerTempo em timestamp do atendimento
solicitacao_data_registrodatetimeData e hora do pedido
solicitacao_arquivamentodatetimeData e hora do arquivamento do pedido
solicitacao_houve_reclamacaostringInforma a existência de reclamação no pedido
solicitacao_pedido_respondidostringInforma a existência de resposta no pedido
solicitacao_houve_recurso_1stringInforma a existência de recurso em primeira instância no pedido
solicitacao_houve_recurso_2stringInforma a existência de recurso em segunda instância no pedido
orgao_idintegerID do órgão
orgao_nomestringNome do órgão
situacao_idintegerID da situação
situacao_titulostringTítulo da situação
status_idintegerID do status
status_titulostringTítulo do status
categoria_idintegerID da categoria
categoria_titulostringTítulo da categoria
origem_idintegerID da origem
origem_titulostringTítulo da origem
solicitacao_urlstringURL do pedido
solicitacao_pdfstringURL do pedido em PDF

FEED RSS

Forma simplificada de apresentar notícias

A sigla RSS tem mais de um significado. Alguns a definem como RDF Site Summary, outros a denominam Really Simple Syndication. Há ainda os que a entendem como Rich Site Summary.

RSS é um padrão desenvolvido em linguagem XML que permite aos responsáveis por sites e blogs divulgarem notícias ou novidades destes. Para isso, o link e o resumo daquela notícia (ou a notícia na íntegra) é armazenado em um arquivo de extensão ".xml", ".rss" ou ".rdf" (é possível utilizar outras extensões). Este arquivo é conhecido como feed ou feed RSS.

Uma pessoa interessada em obter as notícias ou as novidades de um site deve incluir o link do feed deste em um programa ou serviço leitor de RSS (também chamado de agregador). Este software (ou serviço, se for um site) tem a função de ler o conteúdo dos feeds que indexa e mostrá-lo em sua interface.



EXEMPLO DE COMO USAR A URL

Descrição da utilização da URL para acesso aos dados abertos no formato RSS. Este formato está limitado à 50 registros, deste modo, caso a solicitação tenha como retorno mais de 50 registros, ela será truncada no quinquagésimo registro.

https://fapspmg.es.gov.br/dados-abertos/base/rss/ano/mês.html

base: Estão disponíveis: Notícia e Vídeo.

ano: Registros relativos ao ano informado aqui. Este parâmetro é opcional.

mês: Registros relativos ao mês informado aqui. Este parâmetro é opcional.

1: https://fapspmg.es.gov.br/dados-abertos/noticia/rss.html - Serão exibidas até as 50 ultimas notícias publicadas.

2: https://fapspmg.es.gov.br/dados-abertos/noticia/rss/2017.html - Serão exibidas até as 50 ultimas notícias publicadas em 2017.

3: https://fapspmg.es.gov.br/dados-abertos/noticia/rss/2017/03.html - Serão exibidas até as 50 ultimas notícias publicadas em março de 2017.



CAMPOS DE RETORNO

CAMPO TIPO DESCRIÇÃO
title texto Título da matéria
link texto Endereço da postagem
guid URL Endereço permanente da postagem
description texto Descrição da postagem
media URL Endereço de uma midia, que pode ser uma imagem ou vídeo
category texto Editoria das postagens
pubDate datetime Data e hora da criação da publicação
lastBuildDate datetime Data e hora da ultima alteração da publicação


Exemplo de saída do arquivo.

<rss version="2.0">
   <channel>
      <title>titulo da página</title>
      <link>link da página</link>
      <description>descrição da página</description>
      <language>pt-BR</language>
      <copyright>registro</copyright>
      <item>
         <title>titulo</title>
         <link>url da postagem</link>
         <guid>url permanente da postagem</guid>
         <description">descrição da postagem</description>
         <media">midia da postagem, podendo ser uma imagem ou vídeo</media>
         <category">categoria em que a postagem se enquadra</category>
         <pubDate">data de publicação</pubDate>
         <lastBuildDate">ultima alteração</lastBuildDate>
      </item>
      ...
   </channel>
</rss>



FEED RSS DISPONÍVEIS

Clique nos links para copiar o conteúdo automaticamente.

https://fapspmg.es.gov.br/dados-abertos/noticia/rss.html

https://fapspmg.es.gov.br/dados-abertos/video/rss.html

ÓRGÃO

Órgãos do site



URL DA API

https://fapspmg.es.gov.br/dados-abertos/base/formato/filtro/id.html



EXEMPLO DE COMO USAR A URL

Descrição da utilização da URL para acesso aos dados abertos. Para os formatos disponíveis, não há limite de registros para o retorno da informação.

base: Órgão.

formato: Disponível em JSON, CSV, TXT, HTML, XML e PDF.

filtro: Grupo.

id: ID do órgão. Este parâmetro é opcional.


1: https://fapspmg.es.gov.br/dados-abertos/orgao/json/1.html - Serão exibidos todos os registros cujo grupo corresponda ao ID 1.



GRUPO DE ÓRGÃO

IDCAMPO
-Todos os registros
1Presidência
2Departamento
4Setor
6Administrativo
8Conselho


TODOS OS GRUPOS DE ÓRGÃOS

https://fapspmg.es.gov.br/dados-abertos/orgao/json/grupo.html

https://fapspmg.es.gov.br/dados-abertos/orgao/json/grupo.html



CAMPOS DE RETORNO

CAMPOTIPODESCRIÇÃO
orgao_idintegerID do registro
orgao_titulostringNome do órgão
orgao_titulo_alternativostringTítulo alternativo para o órgão
orgao_emailstringEmail do órgão
orgao_telefonestringNúmero do telefone
orgao_celularstringNúmero do celular
grupo_idintegerID do grupo do órgão
grupo_titulostringTítulo do órgão
orgao_urlstringURL do órgão

POSTAGEM

Postagens no site



URL DA API

https://fapspmg.es.gov.br/dados-abertos/base/formato/filtro/ano/mes.html



EXEMPLO DE COMO USAR A URL

Descrição da utilização da URL para acesso aos dados abertos. Para os formatos disponíveis, não há limite de registros para o retorno da informação.

base: Notícia, Vídeo ou Galeria.

formato: Disponível em JSON, CSV, TXT, HTML, XML e PDF.

filtro: Editoria da postagem.

ano: Registros relativos ao ano informado aqui. Este parâmetro é obrigatório.

mês: Registros relativos ao mês informado aqui. Este parâmetro é opcional.


1: https://fapspmg.es.gov.br/dados-abertos/noticia/json/1/2020.html - Serão exibidos todos os registros cuja editoria corresponda ao ID 1 e ano de 2020.

2: https://fapspmg.es.gov.br/dados-abertos/video/json/-/2020/12.html - Serão exibidos todos os registros de qualquer editoria e que corresponda ao ano de 2020 e mês 12.



EDITORIA

IDCAMPO
-Todos os registros
6Receita Federal
8Trabalho e Emprego
9Vídeos
10Notícias
11Banner Principal
12Economia
13Banner Principal-2zz7xspvcn


TODAS AS EDITORIAS

https://fapspmg.es.gov.br/dados-abertos/noticia/json/editoria.html

https://fapspmg.es.gov.br/dados-abertos/noticia/json/editoria.html



CAMPOS DE RETORNO

CAMPOTIPODESCRIÇÃO
post_idintegerID do registro
post_titulostringTitulo da postagem
post_resumostringResumo da postagem
post_fontestringFonte da postagem
post_autorstringAutor da postagem
post_data_publicacaodatetimeData e hora de publicação
post_ultima_alteracaodatetimeData e hora da última alteração na postagem
editoria_idintegerID da editoria
editoria_titulostringTitulo da editoria
post_imagemstringImagem de destaque da postagem
post_urlstringURL da postagem

LICITAÇÕES

Licitações no site



URL DA API

https://fapspmg.es.gov.br/dados-abertos/base/formato/filtro/ano/mes.html



EXEMPLO DE COMO USAR A URL

Descrição da utilização da URL para acesso aos dados abertos. Para os formatos disponíveis, não há limite de registros para o retorno da informação.

base: Licitação.

formato: Disponível em JSON, CSV, TXT, HTML, XML e PDF.

filtro: Modalidade da licitação.

ano: Registros relativos ao ano informado aqui. Este parâmetro é obrigatório.

mês: Registros relativos ao mês informado aqui. Este parâmetro é opcional.


1: https://fapspmg.es.gov.br/dados-abertos/licitacao/json/1/2020.html - Serão exibidos todos os registros cuja modalidade licitatório corresponda ao ID 1 e ano de 2020.

2: https://fapspmg.es.gov.br/dados-abertos/licitacao/json/-/2020/12.html - Serão exibidos todos os registros de qualquer modalidade licitatório e que corresponda ao ano de 2020 e mês 12.



MODALIDADES LICITATÓRIAS

IDCAMPO
-Todos os registros
1Pregão presencial
2Tomada de preços
3Convite
4Pregão eletrônico
5Concorrência pública
6Chamada pública
7Concurso
8Leilão
9Dispensa de licitação
10Inexigibilidade licitação
11Credenc Imóvel
12Credenc Laboratório
13Aditivo de Contrato
14Adesão
15Ata de Registro de Preço
16Contrato
17Rescisão de contrato
18Aditivo de Convênio
19Convênio
20Termo de colaboração


TODAS AS MODALIDADES

https://fapspmg.es.gov.br/dados-abertos/licitacao/json/modalidade.html

https://fapspmg.es.gov.br/dados-abertos/licitacao/json/modalidade.html



CAMPOS DE RETORNO

CAMPOTIPODESCRIÇÃO
licitacao_idintegerID do registro
licitacao_titulostringTitulo do registro
licitacao_objetostringDescrição do objeto do processo licitatório
licitacao_prazo_impugnacaointegerPrazo em dias para impugnação do processo licitatório
licitacao_processostringNúmero do processo interno
licitacao_data_registrodatetimeData e hora de criação do registro
licitacao_data_aberturadatetimeData e hora de abertura da licitação
licitacao_data_publicacaodatetimeData e hora de publicação da licitação
licitacao_data_inicio_propostadatetimeData e hora do início do acolhimento das propostas
licitacao_data_limite_propostadatetimeData e hora do fim do acolhimento das propostas
licitacao_data_abertura_propostadatetimeData e hora da abertura das propostas
licitacao_data_disputa_precodatetimeData e hora da disputa de preços
modalidade_idintegerID da modalidade licitatória
modalidade_titulostringTitulo da modalidade licitatória
modalidade_descricaostringDescrição da modalidade licitatória
genero_idintegerID do gênero do processo
genero_titulostringDescrição do gênero do processo
recurso_idintegerID da fonte de recursos
recurso_titulostringDescrição da fonte de recursos
tipo_idintegerID do tipo de licitação
tipo_titulostringDescrição do tipo de licitação
status_idintegerID do status da licitação
status_titulostringDescrição do status da licitação
situacao_idintegerID da situação da licitação
situacao_titulostringDescrição da situação da licitação
licitacao_urlstringURL da licitação
arquivosarrayTodos os arquivos disponíveis no processo licitatório

DOCUMENTOS

Documentos no site



URL DA API

https://fapspmg.es.gov.br/dados-abertos/base/formato/filtro/ano/mes.html



EXEMPLO DE COMO USAR A URL

Descrição da utilização da URL para acesso aos dados abertos. Para os formatos disponíveis, não há limite de registros para o retorno da informação.

base: Documento.

formato: Disponível em JSON, CSV, TXT, HTML, XML e PDF.

filtro: Tipo de documento.

ano: Registros relativos ao ano informado aqui. Este parâmetro é obrigatório.

mês: Registros relativos ao mês informado aqui. Este parâmetro é opcional.


1: https://fapspmg.es.gov.br/dados-abertos/documento/json/1/2020.html - Serão exibidos todos os registros cujo tipo de documento corresponda ao ID 1 e ano de 2020.

2: https://fapspmg.es.gov.br/dados-abertos/licitacao/json/-/2020/12.html - Serão exibidos todos os registros de qualquer tipo de documento e que corresponda ao ano de 2020 e mês 12.



TIPO DE DOCUMENTOS

IDCAMPO
-Todos os registros
1Ata de Registro de Preços
2Contrato
3Convênio
4Adesão de Ata


TODOS OS TIPOS DE DOCUMENTOS

https://fapspmg.es.gov.br/dados-abertos/documento/json/tipo.html

https://fapspmg.es.gov.br/dados-abertos/documento/json/tipo.html



CAMPOS DE RETORNO

CAMPOTIPODESCRIÇÃO
documento_idintegerID do registro
documento_titulostringTítulo do registro
documento_titulo_alternativostringTítulo alternativo para o documento
documento_objetostringDescrição do objeto do documento
documento_processostringNúmero do processo interno
documento_data_registrodatetimeData e hora de criação do registro
documento_vigencia_inicialdatetimeData e hora do início da vigência
documento_vigencia_finaldatetimeData e hora do término da vigência
documento_data_assinaturadatetimeData e hora da assinatura do documento
documento_data_publicacaodatetimeData e hora da publicação
documento_data_rescisaodatetimeData e hora da rescisão do documento
documento_data_suspensaodatetimeData e hora da suspensão
documento_data_limite_aditivodatetimeData e hora do limite para aditivar
documento_valor_totalfloatValor total do documento
tipo_idintegerID do tipo de documento
tipo_titulostringTítulo do tipo de documento
tipo_descricaostringDescrição do tipo de documento
status_idintegerID do status do documento
status_titulostringTítulo do status
categoria_idintegerID da categoria do documento
categoria_titulostringTítulo da categoria
origem_idintegerID da origem do documento
origem_titulostringTítulo da origem
situacao_idintegerID da situação do documento
situacao_titulostringTítulo da situação
documento_urlstringURL do documento
aditivoarrayTodos os aditivos do documento

LEGISLAÇÃO

Legislação do site



URL DA API

https://fapspmg.es.gov.br/dados-abertos/base/formato/filtro/ano/mes.html



EXEMPLO DE COMO USAR A URL

Descrição da utilização da URL para acesso aos dados abertos. Para os formatos disponíveis, não há limite de registros para o retorno da informação.

base: Legislação.

formato: Disponível em JSON, CSV, TXT, HTML, XML e PDF.

filtro: Tipo de ato.

ano: Registros relativos ao ano informado aqui. Este parâmetro é obrigatório.

mês: Registros relativos ao mês informado aqui. Este parâmetro é opcional.


1: https://fapspmg.es.gov.br/dados-abertos/legislacao/json/1/2020.html - Serão exibidos todos os registros cujo tipo de ato corresponda ao ID 1 e ano de 2020.

2: https://fapspmg.es.gov.br/dados-abertos/legislacao/json/-/2020/12.html - Serão exibidos todos os registros de qualquer tipo de ato e que corresponda ao ano de 2020 e mês 12.



TIPO DE ATO

IDCAMPO
-Todos os registros
1Lei Ordinária
3Lei Orgânica
5Decreto
7Emenda Lei Orgânica
8Lei Complementar
9Portaria
10Resolução
11Instrução Normativa
12Ata
13Lei Federal


TODOS OS TIPOS DE ATOS

https://fapspmg.es.gov.br/dados-abertos/legislacao/json/tipo-de-ato.html

https://fapspmg.es.gov.br/dados-abertos/legislacao/json/tipo-de-ato.html



CAMPOS DE RETORNO

CAMPOTIPODESCRIÇÃO
legislacao_idintegerID do registro
legislacao_titulostringTítulo do norma
legislacao_titulo_alternativostringTítulo alternativo para a norma
legislacao_siglastringDescrição da norma
legislacao_numerointegerNúmero da norma
legislacao_ementastringEmenta da norma
legislacao_fontestringFonte da norma
legislacao_data_publicacaodatetimeData e hora de publicação da norma
origem_idintegerID da origem da norma
origem_titulostringTítulo da origem
promulgador_idintegerID do promulgador da norma
promulgador_nomestringNome do promulgador
situacao_idintegerID da situação da norma
situacao_titulostringTítulo da situação
ato_idintegerID do tipo de ato da norma
ato_titulostringTítulo do tipo de ato
legislacao_texto_htmlstringURL do texto em HTML
arquivo_urlstringURL da norma
legislacao_url_curtastringURL curta da norma

Aguarde, enviando dados!

clear