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.

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”).

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

https://camaraiuna.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://camaraiuna.es.gov.br/dados-abertos/licitacao/json/-/2024/12.html

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.

Exemplo de saída do arquivo com ERRO.

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.

URL DA API

https://camaraiuna.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://camaraiuna.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://camaraiuna.es.gov.br/dados-abertos/e-sic/json/-/2024/12.html - Serão exibidos todos os registros de qualquer situação e que corresponda ao ano de 2024 e mês 12.

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://camaraiuna.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://camaraiuna.es.gov.br/dados-abertos/noticia/rss.html - Serão exibidas até as 50 ultimas notícias publicadas.

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

3: https://camaraiuna.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.

Exemplo de saída do arquivo.

URL DA API

https://camaraiuna.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://camaraiuna.es.gov.br/dados-abertos/orgao/json/1.html - Serão exibidos todos os registros cujo grupo corresponda ao ID 1.

URL DA API

https://camaraiuna.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://camaraiuna.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://camaraiuna.es.gov.br/dados-abertos/video/json/-/2024/12.html - Serão exibidos todos os registros de qualquer editoria e que corresponda ao ano de 2024 e mês 12.

URL DA API

https://camaraiuna.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://camaraiuna.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://camaraiuna.es.gov.br/dados-abertos/licitacao/json/-/2024/12.html - Serão exibidos todos os registros de qualquer modalidade licitatório e que corresponda ao ano de 2024 e mês 12.

URL DA API

https://camaraiuna.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://camaraiuna.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://camaraiuna.es.gov.br/dados-abertos/licitacao/json/-/2024/12.html - Serão exibidos todos os registros de qualquer tipo de documento e que corresponda ao ano de 2024 e mês 12.

URL DA API

https://camaraiuna.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://camaraiuna.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://camaraiuna.es.gov.br/dados-abertos/legislacao/json/-/2024/12.html - Serão exibidos todos os registros de qualquer tipo de ato e que corresponda ao ano de 2024 e mês 12.