Documentação da API - Portal de Dados Abertos do Estado do Ceará

Visão geral

O Portal de Dados Abertos oferece uma API pública que permite consultar, de forma automatizada, todos os conjuntos de dados publicados pelos órgãos do Estado do Ceará. Com ela, pesquisadores, jornalistas e desenvolvedores podem integrar os dados em painéis, aplicações e análises, sempre com as informações mais atuais.

A API segue o padrão CKAN (Action API) e retorna dados em formato JSON. A maioria das consultas de leitura é aberta e não exige autenticação.

URL base https://homologacao.ckan.cge.ce.gov.br/api/3/action/

Como funciona

Cada funcionalidade é uma "action" chamada pela URL base seguida do nome da action. Os parâmetros vão na query string (GET). A resposta é sempre um objeto JSON com os campos success e result.

https://homologacao.ckan.cge.ce.gov.br/api/3/action/<nome_da_action>?<parametros>

Buscar conjuntos de dados

package_search — pesquisa conjuntos de dados por texto, com filtros e paginação.

Exemplo: buscar por "servidores"

https://homologacao.ckan.cge.ce.gov.br/api/3/action/package_search?q=servidores

Exemplo: filtrar por órgão e formato

https://homologacao.ckan.cge.ce.gov.br/api/3/action/package_search?fq=organization:cge+res_format:CSV

Exemplo: paginação (10 por página, segunda página)

https://homologacao.ckan.cge.ce.gov.br/api/3/action/package_search?rows=10&start=10

Parâmetro	Descrição
`q`	Termo de busca livre.
`fq`	Filtro por campo, ex.: organization, groups (temas), res_format, tags.
`rows`	Quantidade de resultados por página (padrão 10).
`start`	Deslocamento inicial (para paginar).
`sort`	Ordenação, ex.: metadata_modified desc.

Detalhar um conjunto de dados

package_show — retorna todos os metadados e recursos de um conjunto específico, pelo seu identificador (slug) ou id.

https://homologacao.ckan.cge.ce.gov.br/api/3/action/package_show?id=servidores-estaduais

Órgãos e temas

organization_list — lista os órgãos (organizações) publicadores.

https://homologacao.ckan.cge.ce.gov.br/api/3/action/organization_list?all_fields=true

group_list — lista os temas.

https://homologacao.ckan.cge.ce.gov.br/api/3/action/group_list?all_fields=true

organization_show — detalha um órgão e seus conjuntos de dados.

https://homologacao.ckan.cge.ce.gov.br/api/3/action/organization_show?id=cge&include_datasets=true

Consultar os dados de um recurso

Para recursos tabulares (CSV) processados pelo portal, é possível consultar os registros diretamente, sem baixar o arquivo, usando o datastore.

datastore_search — retorna as linhas de um recurso pelo seu resource_id.

https://homologacao.ckan.cge.ce.gov.br/api/3/action/datastore_search?resource_id=<id_do_recurso>&limit=5

O resource_id aparece na página de cada recurso e no resultado de package_show.

Formato da resposta

Toda resposta é um JSON com esta estrutura:

{
  "success": true,
  "result": { ... },
  "help": "https://homologacao.ckan.cge.ce.gov.br/api/3/action/help_show?name=package_search"
}

Quando success for false, o campo error traz a descrição do problema. Verifique sempre o valor de success antes de usar result.

Dicas e limites

As consultas de leitura são públicas e podem ser feitas direto pelo navegador.
Use rows e start para paginar grandes volumes em vez de pedir tudo de uma vez.
Para uso intensivo, mantenha um intervalo razoável entre as requisições.
Os dados são abertos e reutilizáveis; cite o Portal de Dados Abertos do Governo do Ceará como fonte.

Referência completa de todas as actions disponíveis na documentação oficial do CKAN: docs.ckan.org/en/latest/api.