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://ipmg.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://ipmg.es.gov.br/dados-abertos/licitacao/json/-/2024/11.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.
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.
Fonte de consulta: Manual dos dados abertos: governo
e-SIC
Sistema Eletrônico do Serviço de Informações ao Cidadão
URL DA API
https://ipmg.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://ipmg.es.gov.br/dados-abertos/e-sic/json/1/2024.html - Serão exibidos todos os registros cuja situação corresponda ao ID 1 e ano de 2024.
2: https://ipmg.es.gov.br/dados-abertos/e-sic/json/-/2024/11.html - Serão exibidos todos os registros de qualquer situação e que corresponda ao ano de 2024 e mês 11.
SITUAÇÃO
| ID | CAMPO |
|---|---|
| - | Todos os registros |
| 4 | Não conhecimento |
| 5 | Negado |
| 7 | Parcialmente Atendido |
| 10 | Atendido |
TODOS AS SITUAÇÃOES
https://ipmg.es.gov.br/dados-abertos/e-sic/json/situacao.html
https://ipmg.es.gov.br/dados-abertos/e-sic/json/situacao.html
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| solicitacao_id | integer | ID do registro |
| solicitacao_protocolo | string | Protocolo do pedido de informação |
| solicitacao_resumo | string | Resumo do pedido |
| solicitacao_prorrogacao | integer | Quantidade de prorrogações sofridas pelo pedido |
| solicitacao_tempo_atendimento | integer | Tempo em timestamp do atendimento |
| solicitacao_data_registro | datetime | Data e hora do pedido |
| solicitacao_arquivamento | datetime | Data e hora do arquivamento do pedido |
| solicitacao_houve_reclamacao | string | Informa a existência de reclamação no pedido |
| solicitacao_pedido_respondido | string | Informa a existência de resposta no pedido |
| solicitacao_houve_recurso_1 | string | Informa a existência de recurso em primeira instância no pedido |
| solicitacao_houve_recurso_2 | string | Informa a existência de recurso em segunda instância no pedido |
| orgao_id | integer | ID do órgão |
| orgao_nome | string | Nome do órgão |
| situacao_id | integer | ID da situação |
| situacao_titulo | string | Título da situação |
| status_id | integer | ID do status |
| status_titulo | string | Título do status |
| categoria_id | integer | ID da categoria |
| categoria_titulo | string | Título da categoria |
| origem_id | integer | ID da origem |
| origem_titulo | string | Título da origem |
| solicitacao_url | string | URL do pedido |
| solicitacao_pdf | string | URL 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://ipmg.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://ipmg.es.gov.br/dados-abertos/noticia/rss.html - Serão exibidas até as 50 ultimas notícias publicadas.
2: https://ipmg.es.gov.br/dados-abertos/noticia/rss/2017.html - Serão exibidas até as 50 ultimas notícias publicadas em 2017.
3: https://ipmg.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://ipmg.es.gov.br/dados-abertos/noticia/rss.html
https://ipmg.es.gov.br/dados-abertos/video/rss.html
ÓRGÃO
Órgãos do site
URL DA API
https://ipmg.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://ipmg.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
| ID | CAMPO |
|---|---|
| - | Todos os registros |
| 1 | Presidência |
| 2 | Departamento |
| 4 | Setor |
| 6 | Administrativo |
| 8 | Conselho |
TODOS OS GRUPOS DE ÓRGÃOS
https://ipmg.es.gov.br/dados-abertos/orgao/json/grupo.html
https://ipmg.es.gov.br/dados-abertos/orgao/json/grupo.html
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| orgao_id | integer | ID do registro |
| orgao_titulo | string | Nome do órgão |
| orgao_titulo_alternativo | string | Título alternativo para o órgão |
| orgao_email | string | Email do órgão |
| orgao_telefone | string | Número do telefone |
| orgao_celular | string | Número do celular |
| grupo_id | integer | ID do grupo do órgão |
| grupo_titulo | string | Título do órgão |
| orgao_url | string | URL do órgão |
POSTAGEM
Postagens no site
URL DA API
https://ipmg.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://ipmg.es.gov.br/dados-abertos/noticia/json/1/2024.html - Serão exibidos todos os registros cuja editoria corresponda ao ID 1 e ano de 2024.
2: https://ipmg.es.gov.br/dados-abertos/video/json/-/2024/11.html - Serão exibidos todos os registros de qualquer editoria e que corresponda ao ano de 2024 e mês 11.
EDITORIA
| ID | CAMPO |
|---|---|
| - | Todos os registros |
| 6 | Receita Federal |
| 8 | Trabalho e Emprego |
| 9 | Vídeos |
| 10 | Notícias |
| 11 | Banner Principal |
| 12 | Economia |
| 13 | Banner Principal-2zz7xspvcn |
TODAS AS EDITORIAS
https://ipmg.es.gov.br/dados-abertos/noticia/json/editoria.html
https://ipmg.es.gov.br/dados-abertos/noticia/json/editoria.html
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| post_id | integer | ID do registro |
| post_titulo | string | Titulo da postagem |
| post_resumo | string | Resumo da postagem |
| post_fonte | string | Fonte da postagem |
| post_autor | string | Autor da postagem |
| post_data_publicacao | datetime | Data e hora de publicação |
| post_ultima_alteracao | datetime | Data e hora da última alteração na postagem |
| editoria_id | integer | ID da editoria |
| editoria_titulo | string | Titulo da editoria |
| post_imagem | string | Imagem de destaque da postagem |
| post_url | string | URL da postagem |
LICITAÇÕES
Licitações no site
URL DA API
https://ipmg.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://ipmg.es.gov.br/dados-abertos/licitacao/json/1/2024.html - Serão exibidos todos os registros cuja modalidade licitatório corresponda ao ID 1 e ano de 2024.
2: https://ipmg.es.gov.br/dados-abertos/licitacao/json/-/2024/11.html - Serão exibidos todos os registros de qualquer modalidade licitatório e que corresponda ao ano de 2024 e mês 11.
MODALIDADES LICITATÓRIAS
| ID | CAMPO |
|---|---|
| - | Todos os registros |
| 1 | Pregão presencial |
| 2 | Tomada de preços |
| 3 | Convite |
| 4 | Pregão eletrônico |
| 5 | Concorrência pública |
| 6 | Chamada pública |
| 7 | Concurso |
| 8 | Leilão |
| 9 | Dispensa de licitação |
| 10 | Inexigibilidade licitação |
| 11 | Credenciamento |
| 13 | Aditivo de Contrato |
| 14 | Adesão |
| 15 | Ata de Registro de Preço |
| 16 | Contrato |
| 17 | Rescisão de contrato |
| 18 | Aditivo de Convênio |
| 19 | Convênio |
| 20 | Termo de colaboração |
TODAS AS MODALIDADES
https://ipmg.es.gov.br/dados-abertos/licitacao/json/modalidade.html
https://ipmg.es.gov.br/dados-abertos/licitacao/json/modalidade.html
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| licitacao_id | integer | ID do registro |
| licitacao_titulo | string | Titulo do registro |
| licitacao_objeto | string | Descrição do objeto do processo licitatório |
| licitacao_prazo_impugnacao | integer | Prazo em dias para impugnação do processo licitatório |
| licitacao_processo | string | Número do processo interno |
| licitacao_data_registro | datetime | Data e hora de criação do registro |
| licitacao_data_abertura | datetime | Data e hora de abertura da licitação |
| licitacao_data_publicacao | datetime | Data e hora de publicação da licitação |
| licitacao_data_inicio_proposta | datetime | Data e hora do início do acolhimento das propostas |
| licitacao_data_limite_proposta | datetime | Data e hora do fim do acolhimento das propostas |
| licitacao_data_abertura_proposta | datetime | Data e hora da abertura das propostas |
| licitacao_data_disputa_preco | datetime | Data e hora da disputa de preços |
| modalidade_id | integer | ID da modalidade licitatória |
| modalidade_titulo | string | Titulo da modalidade licitatória |
| modalidade_descricao | string | Descrição da modalidade licitatória |
| genero_id | integer | ID do gênero do processo |
| genero_titulo | string | Descrição do gênero do processo |
| recurso_id | integer | ID da fonte de recursos |
| recurso_titulo | string | Descrição da fonte de recursos |
| tipo_id | integer | ID do tipo de licitação |
| tipo_titulo | string | Descrição do tipo de licitação |
| status_id | integer | ID do status da licitação |
| status_titulo | string | Descrição do status da licitação |
| situacao_id | integer | ID da situação da licitação |
| situacao_titulo | string | Descrição da situação da licitação |
| licitacao_url | string | URL da licitação |
| arquivos | array | Todos os arquivos disponíveis no processo licitatório |
DOCUMENTOS
Documentos no site
URL DA API
https://ipmg.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://ipmg.es.gov.br/dados-abertos/documento/json/1/2024.html - Serão exibidos todos os registros cujo tipo de documento corresponda ao ID 1 e ano de 2024.
2: https://ipmg.es.gov.br/dados-abertos/licitacao/json/-/2024/11.html - Serão exibidos todos os registros de qualquer tipo de documento e que corresponda ao ano de 2024 e mês 11.
TIPO DE DOCUMENTOS
| ID | CAMPO |
|---|---|
| - | Todos os registros |
| 1 | Ata de Registro de Preços |
| 2 | Contrato |
| 3 | Convênio |
| 4 | Adesão de Ata |
| 5 | Credenciamento |
TODOS OS TIPOS DE DOCUMENTOS
https://ipmg.es.gov.br/dados-abertos/documento/json/tipo.html
https://ipmg.es.gov.br/dados-abertos/documento/json/tipo.html
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| documento_id | integer | ID do registro |
| documento_titulo | string | Título do registro |
| documento_titulo_alternativo | string | Título alternativo para o documento |
| documento_objeto | string | Descrição do objeto do documento |
| documento_processo | string | Número do processo interno |
| documento_data_registro | datetime | Data e hora de criação do registro |
| documento_vigencia_inicial | datetime | Data e hora do início da vigência |
| documento_vigencia_final | datetime | Data e hora do término da vigência |
| documento_data_assinatura | datetime | Data e hora da assinatura do documento |
| documento_data_publicacao | datetime | Data e hora da publicação |
| documento_data_rescisao | datetime | Data e hora da rescisão do documento |
| documento_data_suspensao | datetime | Data e hora da suspensão |
| documento_data_limite_aditivo | datetime | Data e hora do limite para aditivar |
| documento_valor_total | float | Valor total do documento |
| tipo_id | integer | ID do tipo de documento |
| tipo_titulo | string | Título do tipo de documento |
| tipo_descricao | string | Descrição do tipo de documento |
| status_id | integer | ID do status do documento |
| status_titulo | string | Título do status |
| categoria_id | integer | ID da categoria do documento |
| categoria_titulo | string | Título da categoria |
| origem_id | integer | ID da origem do documento |
| origem_titulo | string | Título da origem |
| situacao_id | integer | ID da situação do documento |
| situacao_titulo | string | Título da situação |
| documento_url | string | URL do documento |
| aditivo | array | Todos os aditivos do documento |
LEGISLAÇÃO
Legislação do site
URL DA API
https://ipmg.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://ipmg.es.gov.br/dados-abertos/legislacao/json/1/2024.html - Serão exibidos todos os registros cujo tipo de ato corresponda ao ID 1 e ano de 2024.
2: https://ipmg.es.gov.br/dados-abertos/legislacao/json/-/2024/11.html - Serão exibidos todos os registros de qualquer tipo de ato e que corresponda ao ano de 2024 e mês 11.
TIPO DE ATO
| ID | CAMPO |
|---|---|
| - | Todos os registros |
| 1 | Lei Ordinária |
| 3 | Lei Orgânica |
| 5 | Decreto |
| 7 | Emenda Lei Orgânica |
| 8 | Lei Complementar |
| 9 | Portaria |
| 10 | Resolução |
| 11 | Instrução Normativa |
| 12 | Ata |
| 13 | Lei Federal |
TODOS OS TIPOS DE ATOS
https://ipmg.es.gov.br/dados-abertos/legislacao/json/tipo-de-ato.html
https://ipmg.es.gov.br/dados-abertos/legislacao/json/tipo-de-ato.html
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| legislacao_id | integer | ID do registro |
| legislacao_titulo | string | Título do norma |
| legislacao_titulo_alternativo | string | Título alternativo para a norma |
| legislacao_sigla | string | Descrição da norma |
| legislacao_numero | integer | Número da norma |
| legislacao_ementa | string | Ementa da norma |
| legislacao_fonte | string | Fonte da norma |
| legislacao_data_publicacao | datetime | Data e hora de publicação da norma |
| origem_id | integer | ID da origem da norma |
| origem_titulo | string | Título da origem |
| promulgador_id | integer | ID do promulgador da norma |
| promulgador_nome | string | Nome do promulgador |
| situacao_id | integer | ID da situação da norma |
| situacao_titulo | string | Título da situação |
| ato_id | integer | ID do tipo de ato da norma |
| ato_titulo | string | Título do tipo de ato |
| legislacao_texto_html | string | URL do texto em HTML |
| arquivo_url | string | URL da norma |
| legislacao_url_curta | string | URL curta da norma |