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://crediguacui.com/dados-abertos/base/formato/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.
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://crediguacui.com/dados-abertos/e-sic/json/2017/01.html
FORMATOS DISPONÍVEIS
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.
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"
}
CSV
Pode ser um formato bem útil, pois é compacto e, portanto, adequado para transferir grandes conjuntos de dados com uma mesma estrutura.
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
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.
https://crediguacui.com/dados-abertos/e-sic/formato/ano/mês.html
formato: Disponível apenas JSON. Em desenvolvimento os formatos XML, CSV, HTML e PDF.
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://crediguacui.com/dados-abertos/e-sic/json/2017.html - Serão exibidos todos os registros de 2017.
2: https://crediguacui.com/dados-abertos/e-sic/json/2017/03.html - Serão exibidos todos os registros de março de 2017.
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| protocolo | texto | Código do pedido de informação |
| resumo_do_pedido | texto | Resumo do pedido realizado pelo internauta |
| data_do_pedido | datetime | Data e hora da realização do pedido |
| data_de_arquivamento | datetime | Data e hora do arquivamento do pedido |
| quantidade_de_prorrogacoes | inteiro | Quantidade de prorrogações sofridas pelo pedido |
| houve_recurso | texto | Informa a existência de recurso no pedido |
| houve_reclamacao | texto | Informa a existência de reclamação no pedido |
| pedido_respondido | texto | Informa a existência de resposta do órgão no pedido |
| orgao | texto | Órgão responsável pela resposta do pedido |
| orgao_email | texto | e-mail do Órgão responsável pela resposta do pedido |
| categoria_do_pedido | texto | Categoria em que o pedido se enquadra |
| ano | inteiro | Ano do pedido |
| mes | inteiro | Mês do pedido |
| link | URL | Endereço permanente do pedido de informação |
| pdf_do_pedido | URL | Arquivo no formato PDF do pedido |
JSON DISPONÍVEIS
Clique no link para copiar o conteúdo automaticamente.
https://crediguacui.com/dados-abertos/e-sic/json/2023.html
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://crediguacui.com/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://crediguacui.com/dados-abertos/noticia/rss.html - Serão exibidas até as 50 ultimas notícias publicadas.
2: https://crediguacui.com/dados-abertos/noticia/rss/2017.html - Serão exibidas até as 50 ultimas notícias publicadas em 2017.
3: https://crediguacui.com/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://crediguacui.com/dados-abertos/noticia/rss.html
https://crediguacui.com/dados-abertos/video/rss.html
ÓRGÃO
Cadastro de órgãos do site
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.
https://crediguacui.com/dados-abertos/orgao/formato/ID.html
formato: Disponível apenas JSON. Em desenvolvimento os formatos XML, CSV, HTML e PDF.
ID: Identificador do orgão. Este parâmetro é opcional.
1: https://crediguacui.com/dados-abertos/orgao/json.html - Serão exibidos todos os registros de orgão.
2: https://crediguacui.com/dados-abertos/orgao/json/id-do-orgao.html - Será exibido apenas o registro com o ID informado.
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| id | texto | Identificador do órgão |
| nome_do_orgao | texto | Nome o órgão |
| nome_alternativo_do_orgao | texto | Nome alternativo e simplicado para o órgão |
| sigla | texto | Sigla do órgão |
| categoria | texto | Categoria em que o órgão se enquadra |
| email_do_orgao | texto | e-mail do órgão |
| telefone_do_orgao | número | Telefone do órgão sem máscara |
| celular_do_orgao | número | Celular do órgão sem máscara |
| imagem | url | Endereço da imagem vinculada ao órgão |
| legenda_da_imagem | texto | Legenda da imagem vinculada ao órgão |
| link | URL | Endereço permanente do órgão |
| membros | objeto | Objeto contendo os campos: cargo, posicao, nome, matricula, celular, email e data_de_nomeacao |
| endereco | objeto | Objeto contendo os campos: tipo_de_logradouro, logradouro, numero, bairro, cidade, uf e cep |
| outros_contatos | objeto | Objeto contendo o campo: contato |
| link_licitacoes_do_orgao | url | Endereço da página com as licitações relacionadas ao órgão |
| link_documentos_do_orgao | url | Endereço da página com os contratos, atas convênios e etc. relacionadas ao órgão |
JSON DISPONÍVEIS
Clique no link para copiar o conteúdo automaticamente.
https://crediguacui.com/dados-abertos/orgao/json.html
POSTAGENS
Ultimas postagens (notícias, vídeos, galerias e etc.) no site
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.
https://crediguacui.com/dados-abertos/base/formato/ano/mes.html
base: Disponível noticia e video.
formato: Disponível apenas JSON. Em desenvolvimento os formatos XML, CSV, HTML e PDF.
ano: Postagens relativas ao ano informado aqui. Este parâmetro é obrigatório.
mês: Registros relativos ao mês informado aqui. Este parâmetro é opcional.
1: https://crediguacui.com/dados-abertos/noticia/json/2017.html - Serão exibidas todas as notícias publicadas em 2017.
2: https://crediguacui.com/dados-abertos/noticia/json/2017/03.html - Serão exibidas todas as notícias publicadas em março de 2017.
CAMPOS DE RETORNO
| CAMPO | TIPO | DESCRIÇÃO |
|---|---|---|
| titulo | texto | Título da postagem |
| resumo | texto | Resumo da postagem |
| editoria | texto | Editoria da postagem |
| fonte | texto | Origem da publicaçao |
| autor | texto | Responsável pela criação da postagem |
| publicacao | datetime | Data e hora da publicação da postagem |
| ultima_alteracao | datetime | Data e hora da ultima alteração da postagem |
| imagem | url | Imagem de referência da postagem |
| legenda_da_imagem | texto | Legenda da imagem de referência |
| url_video | url | Endereço do vídeo no youtube (exclusivo para video) |
| link | url | Endereço permanente da postagem |
JSON DISPONÍVEIS
Clique nos links para copiar o conteúdo automaticamente.
"noticia"
https://crediguacui.com/dados-abertos/noticia/json/2023.html
https://crediguacui.com/dados-abertos/noticia/json/2023/10.html
"video"
https://crediguacui.com/dados-abertos/video/json/2023.html
https://crediguacui.com/dados-abertos/video/json/2023/10.html