APIs (Application Program Interfaces / Interfaces de Programação de Aplicação) 

APIs são mecanismos que permitem que dois sistemas diferentes se comuniquem usando um conjunto de definições e protocolos e realizem trocas de dados.

O Data Lake PBH oferece um robusto conjunto de APIs que possibilitam o acesso direto a dados estratégicos de diferentes setores da administração pública. Essas APIs são projetadas para garantir uma integração segura e eficiente, permitindo que desenvolvedores, pesquisadores e órgãos públicos acessem informações atualizadas em tempo real. Com elas é possível realizar a atualização automatizada de relatórios e painéis em diversas ferramentas.

Com as APIs do Data Lake PBH, é possível consultar dados de áreas como tributos imobiliários, mobilidade urbana, saúde e muitos outros serviços essenciais da cidade. Essa infraestrutura facilita a criação de soluções personalizadas, painéis interativos e aplicativos que utilizam os dados da prefeitura, promovendo a inovação e o desenvolvimento de novos insights.

As APIs são parte da nossa política de acesso aberto à informação, garantindo que as informações públicas sejam acessíveis, interoperáveis e seguras, fortalecendo a transparência e a colaboração entre governo e sociedade.

O Data Lake da PBH possui as seguintes APIs de dados:

- Power BI REST API - Consumo de Dados

Descrição
A API do Power BI permite o consumo de dados que estão dentro de conjuntos de dados e relatórios no Power BI. Isso inclui a consulta de relatórios, exportação de dados e visualização de dashboards.
Principais Funcionalidades
Exportação de Dados: Você pode consumir dados dos relatórios e conjuntos de dados, exportando-os para diferentes formatos.
Consultar Datasets: Realizar consultas em datasets já existentes.
Exemplo
Get Dataset In Group: Retorna informações sobre um dataset específico.
Export Report: Permite exportar relatórios em formatos como PDF ou PowerPoint, incluindo os dados subjacentes.
Caso de uso
Obter dados brutos ou agregados a partir de visualizações do Power BI para integração em outros sistemas.

- Azure Data Explorer (Kusto) API

Descrição
O Azure Data Explorer (ADX), também conhecido como Kusto, é uma plataforma de análise de dados altamente escalável. A API permite a consulta de grandes volumes de dados em tempo real.
Principais Funcionalidades
Execução de Consultas KQL (Kusto Query Language): Consumir dados executando consultas KQL.
Resultados em Diversos Formatos
Os resultados podem ser consumidos em JSON, CSV e outros formatos.
Exemplo
Query: Executa uma consulta em uma tabela de dados e retorna o resultado.
Control Commands: Para obter metadados ou estados das consultas.
Caso de uso
Consultas ad hoc e consumo de dados em tempo real para dashboards ou sistemas de monitoramento.

- Azure Synapse Analytics REST API

Descrição
A API do Azure Synapse Analytics permite o consumo de dados diretamente de Data Lakes, pools SQL e Spark dentro do Synapse. Você pode executar consultas em dados armazenados e obter os resultados via API.
Principais Funcionalidades
Execução de Queries SQL: Consumir dados por meio da execução de consultas SQL em pools de SQL dedicados.
Execução de Notebooks e Spark Jobs: Para consumir dados de grandes volumes usando Spark.
Exemplo
Execute a SQL Query: Executa uma consulta SQL e retorna os resultados.
Get Spark Job Result: Retorna os resultados de um trabalho Spark, muitas vezes usados para processamento e consumo de grandes volumes de dados.
Caso de Uso
Extração de dados de big data e data warehouses para análises avançadas.

- Azure SQL Database REST API

Descrição
A API para Azure SQL Database permite consumir dados de bancos de dados SQL hospedados no Azure. Isso inclui execução de consultas SQL e extração de dados.
Principais Funcionalidades
Execução de Consultas: Executar consultas SQL diretamente contra um banco de dados Azure SQL e obter os resultados.
Obtenção de Dados de Tabelas: Extrair dados de tabelas ou views.
Exemplo
Query: Submete uma consulta SQL e retorna o conjunto de resultados.
Caso de uso
Consumir dados relacionais de bancos de dados SQL para relatórios ou integração com outros sistemas.

- Azure Data Lake Storage Gen2 API

Descrição
A API do Azure Data Lake Storage Gen2 permite consumir dados de grandes volumes armazenados em formato de arquivo, como CSV, Parquet, ou JSON.
Principais Funcionalidades
Leitura de Arquivos: Ler arquivos diretamente do Data Lake.
Listagem de Diretórios: Obter informações sobre diretórios e arquivos.
Exemplo
Read File: Ler o conteúdo de um arquivo no Data Lake.
List Directory: Listar todos os arquivos e subdiretórios em um diretório.
Caso de uso
Consumo de grandes volumes de dados não estruturados ou semi-estruturados para processamento analítico.

- OData API

Descrição
O OData é um protocolo usado por várias soluções da Microsoft, incluindo o Power BI, para consumo de dados de fontes externas em um formato padronizado. Muitos datasets podem ser expostos como OData Feeds.
Principais Funcionalidades
Leitura de Datasets: Consumir datasets expostos via OData para análises.
Filtragem e Paginação: A API permite aplicar filtros e paginação para consumir apenas os dados relevantes.
Exemplo
GET EntitySet: Consome dados de uma entidade específica.
Caso de uso
Consumo de dados tabulares de fontes web e APIs RESTful para integração com outros sistemas. Essas APIs são adequadas para consumir dados diretamente para uso em relatórios, dashboards, ou integração em aplicações externas. Dependendo da sua necessidade, como volume de dados e formato, você pode escolher a API que melhor se adapta ao seu caso.