API CKAN

A API do CKAN segue o padrão de ações em /api/3/action/. As consultas públicas podem ser feitas sem autenticação. Operações de criação, edição ou exclusão exigem chave de API.

URL básica

https://dados.fortaleza.ce.gov.br/api/3/action/{nome_da_acao}

Ações mais usadas

• status_show: status da instância CKAN.
• package_list: lista de conjuntos de dados.
• package_search: pesquisa de conjuntos de dados.
• package_show: detalhes de um conjunto de dados.
• datastore_search: consulta dados tabulares de um recurso no DataStore.

Exemplo 1: verificar status da API

Curl:

curl -X GET "https://dados.fortaleza.ce.gov.br/api/3/action/status_show" \
  -H "accept: application/json"

Request URL: https://dados.fortaleza.ce.gov.br/api/3/action/status_show

Exemplo 2: listar datasets

Curl:

curl -X GET "https://dados.fortaleza.ce.gov.br/api/3/action/package_list?limit=20" \
  -H "accept: application/json"

Parâmetros adicionais: limit, offset.

Exemplo 3: pesquisar datasets

Curl:

curl -X GET "https://dados.fortaleza.ce.gov.br/api/3/action/package_search?q=saude&rows=10&start=0" \
  -H "accept: application/json"

Parâmetros adicionais: q, rows, start, fq, sort.

Exemplo 4: detalhes de um dataset

Curl:

curl -X GET "https://dados.fortaleza.ce.gov.br/api/3/action/package_show?id=nome-do-dataset" \
  -H "accept: application/json"

Parâmetro obrigatório: id (nome ou id do dataset).

Exemplo 5: consultar dados de um recurso no DataStore

Curl:

curl -X GET "https://dados.fortaleza.ce.gov.br/api/3/action/datastore_search?resource_id=SEU_RESOURCE_ID&limit=50" \
  -H "accept: application/json"

Parâmetros adicionais: resource_id, limit, offset, q, filters.

Autenticação para operações administrativas

Para ações como criação de datasets, envie a chave no cabeçalho Authorization.

curl -X POST "https://dados.fortaleza.ce.gov.br/api/3/action/package_create" \
  -H "Authorization: SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{"name":"dataset-exemplo","title":"Dataset Exemplo","owner_org":"id-da-organizacao"}'

Referência oficial

Documentação CKAN: https://docs.ckan.org/en/latest/api/