Pular para o conteúdo principal

Guia do Usuário para Acesso aos Dados Abertos da PBH via CKAN

O portal CKAN da Prefeitura de Belo Horizonte (PBH) oferece acesso a uma variedade de dados abertos. Esta documentação visa ajudar qualquer pessoa, independente do nível técnico, a navegar e utilizar a plataforma de forma eficiente.

 

1. O que é o CKAN?

O CKAN é uma plataforma para publicar, compartilhar e acessar dados públicos. Na PBH, ele é usado para disponibilizar dados sobre temas variados, como mobilidade, saúde, educação e meio ambiente, para que a população possa acessar essas informações de maneira simples e transparente.

 

2. Acessando os Dados Abertos da PBH

Para acessar os dados abertos da PBH:

  • Navegue pelo portal de dados abertos e explore as categorias de dados.
  • Busque por conjuntos de dados específicos utilizando palavras-chave.
  • Baixe os dados diretamente ou use a API para realizar consultas automáticas.
2.1 Conjunto de Dados

Imagine uma caixa repleta de informações organizadas, prontas para serem exploradas e transformadas em insights poderosos. Essa é a essência de um conjunto de dados (dataset): uma coleção estruturada de informações sobre um tema específico, armazenada em um formato digital acessível, como CSV, JSON ou XML.

 

 

No contexto dos dados abertos, esses conjuntos de dados assumem um papel ainda mais crucial, pois são disponibilizados gratuitamente para qualquer pessoa, sem restrições de direitos autorais ou licenças complexas. Isso significa que você tem o poder de acessar, explorar, analisar e reutilizar essas informações como desejar, seja para fins acadêmicos, comerciais ou simplesmente para saciar sua curiosidade.

2.2 Recursos

Cada recurso de dados é como uma chave única que abre um compartimento específico do conjunto de dados, um tipo distinto de informação. Ao combinar diferentes recursos de dados, você pode explorar o conjunto de dados em sua totalidade, desvendando os segredos que ele guarda.

  • Mas como os recursos de dados se relacionam com os conjuntos de dados?

Em termos técnicos, um recurso de dados é uma representação digital de um subconjunto de um conjunto de dados, assumindo a forma de um arquivo individual. O importante é que cada recurso forneça acesso a uma porção específica e bem definida da informação armazenada no conjunto de dados. Os recursos, em um conjunto de dados, compõem a série histórica desse conjunto.

  • Quais são os benefícios de usar recursos de dados?

    Ao utilizar recursos de dados, você desfruta de diversas vantagens:

    • Maior granularidade: permite o acesso a porções específicas do conjunto de dados, sem precisar lidar com todo o volume de informações de uma vez.
    • Flexibilidade: possibilita a combinação de diferentes recursos para criar visualizações personalizadas e realizar análises mais complexas.
    • Reutilização: permite reutilizar recursos de dados em diferentes projetos e aplicações, sem precisar reprocessar toda a informação.
    • Acessibilidade: facilita o compartilhamento de recursos de dados com outras pessoas de forma mais fácil e segura.

 

 

3. Utilizando a API do CKAN

A API do CKAN permite acesso programático aos dados da PBH, ideal para desenvolvedores e pesquisadores que queiram fazer análises e integrações.

Como acessar a API:
  1. Cada conjunto de dados possui uma URL específica da API.
  2. Use essa URL para realizar consultas e acessar dados em tempo real.
Exemplo básico de solicitação:

Para obter detalhes de um conjunto de dados, envie uma solicitação GET para o endpoint:

GET https://dados.pbh.gov.br/api/3/action/package_show?id=<id_do_conjunto_de_dados>

Este pedido retornará informações sobre o conjunto de dados, como título, descrição e arquivos disponíveis para download.

 

4. Principais Endpoints da API CKAN

  • /package_list – Retorna uma lista de todos os conjuntos de dados disponíveis.
  • /package_show – Fornece detalhes sobre um conjunto específico de dados.
  • /resource_show – Permite acessar detalhes de um recurso dentro de um conjunto de dados.
  • /tag_list – Retorna uma lista de todas as tags, facilitando a busca de dados por tema.

 

5. Exemplo de Busca com Filtros

Para filtrar os dados disponíveis, utilize parâmetros como:

  • q: para busca por palavras-chave.
  • fq: para aplicar filtros avançados, como datas ou categorias específicas.

Exemplo de solicitação com filtro:

GET https://dados.pbh.gov.br/api/3/action/package_search?q=saúde&fq=ano:2023

 

6. Formato das Respostas da API

As respostas da API são geralmente em formato JSON, contendo campos como:

  • success: Indica se a consulta foi bem-sucedida.
  • result: Contém os dados solicitados, incluindo metadados como título, descrição e arquivos disponíveis.

 

7. Exemplos de Uso Prático

A API pode ser usada para integrar dados da PBH em aplicativos, painéis de controle ou para realizar análises automatizadas.

Exemplo prático: Visualizar dados de mobilidade urbana para análise de trânsito em tempo real.

 

8. Segurança e Limitações

O portal CKAN da PBH possui limitações de taxa de acesso para evitar sobrecarga no sistema. Se você planeja fazer muitas requisições, entre em contato com a PBH para verificar os limites permitidos.

 

9. Suporte e Contato

Para dúvidas ou suporte técnico, acesse a seção de ajuda do portal de dados ou entre em contato com a equipe de dados abertos da PBH clicando aqui