Jak korzystać z API serwisu?

API serwisu Dane Publiczne umożliwia łatwą integrację i dostęp do wszystkich metadanych zasobów danych oraz grupujących je zbiorów. Niektóre z tabelarycznych zasobów udostępnionych w otwartych formatach umożliwiają także wybiórcze pobieranie treści zasobów.

Ponieważ serwis Dane Publiczne zbudowany jest otwartym kodzie na popularnym rozwiązaniu CKAN najlepszym przewodnikiem po API jest dokumentacja CKAN - wystarczy podmienić część adresu z demo.ckan.org na danepubliczne.gov.pl. Dla łatwiejszego wystartowania zamieszczamy poniżej kilka przykładowych wywołań.

Przeszukiwanie zbiorów danych

Pełną listę zbiorów danych otrzymamy pod linkiem https://danepubliczne.gov.pl/api/3/action/package_search.

Aby wyszukać interesujący nas termin należy zastosować parametr q: https://danepubliczne.gov.pl/api/3/action/package_search?q=teleadresowa

Otrzymane wyniki można filtrować przy użyciu parametru fq po:

Zbiór danych oraz jego zasoby

Zbiór danych składa się z wielu zasobów oraz metadanych je opisujących. Aby pobrać pełną informację o danym zbiorze danych należy wywołać funkcję package_show podając id lub name zbioru wcześniej wyszukanego przez package_search:

Lista kategorii oraz tagów oraz inne słowniki

Pobranie listy kategorii ( groups w nomenklaturze CKAN): https://danepubliczne.gov.pl/api/3/action/group_list

Pobranie listy tagów: https://danepubliczne.gov.pl/api/3/action/tag_list

Pobranie listy typów zasobów: https://danepubliczne.gov.pl/api/3/action/tag_list?vocabulary_id=resource_types

Pobranie listy organizacji: https://danepubliczne.gov.pl/api/3/action/organization_list

Więcej szczegółów

Szczegółowe informacje na temat API znajdziesz w oficjalnej dokumentacji systemu CKAN.

API do pobierania treści zasobów opisane jest w rozszerzeniu DataStore.

Biblioteki programistyczne

Istnieje już wiele bibliotek programistycznych, z których programiści wdrażający rozwiązania na danych lub dostarczający dane do systemu mogą skorzystać: https://github.com/ckan/ckan/wiki/CKAN-API-Clients

Ten artykuł jest objęty licencją Creative Commons Attribution [Open Data]

Słowa kluczowe

Kliknięcie na słowo kluczowe wyświetli wszystkie zbiory opisane tym słowem