API de Dados do CKAN

Acesse recurso pela web API com poderoso suporte a consultas. Mais informações na documentação principal da API de Dados e do DataStore do CKAN.

Exemplos de código:

Obtenha 5 resultados contendo "jones" em qualquer campo:
curl https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search \
  -H"Authorization:$API_TOKEN" -d '
{
  "resource_id": "785bd6dd-16ea-422f-997f-6fb691aad0bd",
  "limit": 5,
  "q": "jones"
}'
const resp = await fetch(`https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search`, {
    method: 'POST',
    headers: {
        'content-type': 'application/json',
        authorization: API_TOKEN
    },
    body: JSON.stringify({
        resource_id: '785bd6dd-16ea-422f-997f-6fb691aad0bd',
        limit: 5,
        q: 'jones'
    })
})
await resp.json()
$json = @'
{
  "resource_id": "785bd6dd-16ea-422f-997f-6fb691aad0bd",
  "limit": 5,
  "q": "jones"
}
'@
$response = Invoke-RestMethod https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search`
  -Method Post -Body $json -Headers @{"Authorization"="$API_TOKEN"}
$response.result.records

(usando a biblioteca cliente ckanapi)

from ckanapi import RemoteCKAN

rc = RemoteCKAN('https://ckan-ds.pbh.gov.br/pt_BR/', apikey=API_TOKEN)
result = rc.action.datastore_search(
    resource_id="785bd6dd-16ea-422f-997f-6fb691aad0bd",
    limit=5,
    q="jones",
)
print(result['records'])
library(httr2)

req <- request("https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search")
result <- req %>% 
    req_headers(Authorization = API_TOKEN) %>% 
    req_body_json(list(
        resource_id = '785bd6dd-16ea-422f-997f-6fb691aad0bd',
        limit = 5,
        q = 'jones'))
    req_perform %>% 
    resp_body_json
Obtenha resultados com "bacia hidrográfica" ou "pesquisa" como assunto e "ativo" como estágio:
curl https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search \
-H"Authorization:$API_TOKEN" -d '
{
"resource_id": "785bd6dd-16ea-422f-997f-6fb691aad0bd",
  "filters": {
    "subject": ["watershed", "survey"],
    "stage": "active"
  }
}'
const resp = await fetch(`https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search`, {
    method: 'POST',
    headers: {
        'content-type': 'application/json',
        authorization: API_TOKEN
    },
    body: JSON.stringify({resource_id: '785bd6dd-16ea-422f-997f-6fb691aad0bd', filters: {
        subject: ['watershed', 'survey'],
        stage: 'active'
    }})})
await resp.json()
$json = @'
{
  "resource_id": "785bd6dd-16ea-422f-997f-6fb691aad0bd",
  "filters": {
    "subject": ["watershed", "survey"],
    "stage": "active"
  }
}
'@
$response = Invoke-RestMethod https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search`
  -Method Post -Body $json -Headers @{"Authorization"="$API_TOKEN"}
$response.result.records
from ckanapi import RemoteCKAN

rc = RemoteCKAN('https://ckan-ds.pbh.gov.br/pt_BR/', apikey=API_TOKEN)
result = rc.action.datastore_search(
    resource_id="785bd6dd-16ea-422f-997f-6fb691aad0bd",
    filters={
      "subject": ["watershed", "survey"],
      "stage": "active",
    },
)
print(result['records'])
library(httr2)

req <- request("https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search")
result <- req %>% 
    req_headers(Authorization = API_TOKEN) %>% 
    req_body_json(list(
        resource_id='785bd6dd-16ea-422f-997f-6fb691aad0bd', 
        filters = list(
            subject = list("watershed", "survey"), 
            stage = "active")))
    req_perform %>% 
    resp_body_json

Alguns endpoints da API podem ser acessados ​​usando uma string de consulta GET.

Exemplo de consulta (primeiros 5 resultados)

https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search?resource_id=785bd6dd-16ea-422f-997f-6fb691aad0bd&limit=5

Exemplo de consulta (resultados contendo 'jones')

https://ckan-ds.pbh.gov.br/pt_BR/api/action/datastore_search?resource_id=785bd6dd-16ea-422f-997f-6fb691aad0bd&q=jones