Portal de Dados Abertos do Estado de São Paulo

1. Introdução

1.1 O que é o CKAN?

O CKAN (Comprehensive Knowledge Archive Network - ckan.org) é uma plataforma de código aberto para gerenciamento e publicação de conjuntos de dados. Ele é amplamente utilizado por governos, organizações e instituições para compartilhar dados de forma aberta e acessível.

Pode ser utilizado como catálogo interno de dados, porém sua utilização mais abrangente é como um DMS (Data Management System) para Portais de Dados Abertos.

1.2 Objetivo do Manual

Este manual tem como objetivo guiar usuários públicos no uso eficiente do Portal de Dados Abertos de São Paulo para consumir conjuntos de dados.

1.3 Público-Alvo

Usuários Públicos
Usuários que desejam consumir dados de forma programática

1.4 Acesso ao Portal de Dados Abertos

Acesse o endereço do Portal de Dados Abertos: https://dadosabertos.sp.gov.br/
Clique em "Entrar com gov.br" no canto superior direito.
Insira suas credenciais ou crie uma conta seguindo as instruções do portal gov.br.

2. Interface do Portal

Visão Geral:

Dashboard: Painel principal com acesso rápido a conjuntos de dados, organizações e grupos.
Menu Superior: Navegação entre "Conjuntos de Dados", "Organizações", "Grupos", "Painel", "Manual" e "Sobre".
Buscar conjuntos de dados: Pesquise conjuntos de dados por palavras-chave, tags ou filtros clicando em "Conjuntos de Dados".

2.1 Editando seu usuário

Para editar seu usuário, clique no ícone da engrenagem na parte superior direita do Portal:

Nesta página poderá editar os seus dados de usuário:

Nome: Nome fornecido pela plataforma gov.br.
E-mail: E-mail fornecido pelo gov.br
E-mail Institucional: E-mail da sua organização. Deve pertencer a um domínio de organização válido. Caso pertença a uma organização, favor preencher este campo.
Sobre: Uma breve descrição sobre você.
Foto: Imagem exibida no perfil do usuário no portal.

2.2 O que são papéis no Portal

Membros Editores de Organizações: Equipe de pessoas que trabalham para manter os Dados Abertos disponíveis e atualizados ao público geral.
Usuário Público (você): Pode visualizar e baixar dados.

2.3 Criar e Publicar Conjuntos de Dados

Um conjunto de dados (dataset) é o objeto que encapsula um ou mais arquivos de dados (recursos) com metadados relevantes. Um conjunto de dados pode conter um ou mais recursos.

Apenas membros editores de organizações/entidades cadastrados junto à CGE-SP podem publicar conjuntos de dados. Para mais informações, favor entrar em contato através do e-mail suporte.dadosabertos@cge.sp.gov.br.

2.4 Ferramentas de Busca e Filtros

Utilize a barra de busca para encontrar conjuntos de dados por palavras-chave.

Como usar:

Aplique filtros por organização, grupo, tags ou formato de arquivo.
Salve buscas frequentes para acesso rápido.

3. Instruções de uso da API

O Portal de Dados Abertos do Estado de São Paulo disponibiliza uma API para consumo dos grupos, organizações, conjuntos de dados e recursos de forma pública.

Para consumo e atualização dos dados do Portal de forma programática, utilizamos como referência o Guia de API do CKAN para compreender os pontos de extremidade corretos a serem acessados.

Nota: Existem determinados serviços que requerem autenticação (o usuário deve estar logado no portal com seu usuário gov.br) obter um retorno bem sucedido.

3.1 Referência rápida de API

Utilize nossos exemplos de uso da API para consumir dados de forma prática através dos endereços de serviço do Portal.

GET:

Retornar lista de conjuntos de dados:
Retornar conjunto de dados:
Buscar por conjuntos de dados:

POST:

Nota: Para requisições POST, é necessário o envio um objeto JSON como corpo da requisição HTTPS. Para mais detalhes sobre os dados necessários, consulte o Guia de API do CKAN na seção de referência da ação desejada.

Criar um novo conjunto de dados:
Atualizar um conjunto de dados existente:
Criar um novo recurso:

3.2 Chaves API

Para acessar determinadas funções da API é necessário ter as devidas permissões dentro de sua organização. As ações que você pode executar por API são as mesmas que você tem acesso quando utiliza a interface do Portal.

Caso você tenha permissão, poderá ver a aba de Chaves API no seu perfil de usuário no CKAN. Para fazer isso, siga as instruções:

Após efetuar login, clique no seu nome de usuário na barra de navegação superior do Portal:
Caso tenha o acesso necessário, terá acesso à aba de Chaves API:
Digite o nome desejado e crie uma nova chave de API. Ela será gerada e exibida em tela uma única vez.
Com a sua chave de API é possível executar requisições POST que requerem elevação de permissão. Aqui temos um exemplo utilizando o CURL com a nossa nossa chave no cabeçalho para autenticação:
```
curl -X POST \
"https://dadosabertos.sp.gov.br/api/3/action/package_create" \
-H "Authorization: 0123456789abcdef0123456789abcdef" \
-H "Content-Type: application/json" \
-d '{}'
					
```

4. Problemas Comuns e Soluções

Problema: Não consigo publicar um conjunto de dados.
Verifique se você tem permissões de editor ou administrador.

Problema: Esqueci minha senha.
Siga as instruções do site do gov.br para ajuda e detalhes sobre a sua conta. Recuperar senha gov.br

5. Recursos Adicionais

6. Suporte

Para dúvidas técnicas ou sugestões, por gentileza entre em contato via e-mail: suporte.dadosabertos@sp.gov.br

7. Glossário

API: Interface de Programação de Aplicações que permite acesso programático aos dados.
CGE: Controladoria Geral do Estado de São Paulo, responsável pela gestão do Portal de Dados Abertos.
CKAN: Plataforma de gerenciamento de dados abertos. Para mais informações, visite o site oficial do CKAN.
Conjunto de Dados (Dataset): Coleção estruturada de informações, geralmente dividida em recursos (ex: CSV, JSON, XLS etc) que descreve algum domínio, fenômeno, serviço ou coleção de informações, organizada e publicada com metadados.
Grupo: Coleção de conjuntos de dados relacionados a um tema específico.
Etiquetas (Tags): Palavras-chave utilizadas para facilitar a busca e classificação dos conjuntos de dados.
Metadados: Informações descritivas sobre os dados. Exemplos: Título, Descrição, Etiquetas, Autor.
Organização: Órgão ou Entidade responsável por um conjunto de dados.
Previsão de Abertura: Data prevista para a transição da visibilidade do conjunto de dados de privada (rascunho, oculto do público) e pública (acessível a todos os usuários visitantes do portal).
Recurso: Os dados de fato. Arquivo ou link atrelado ao conjunto de dados.
Visibilidade: Define quem pode ver o conjunto de dados (privado ou público).

Manual do Usuário Público - v1.0