API

Interfejs programistyczny aplikacji (API)

Interfejs API platformy SDG pozwala przeglądać i pobierać do dalszego przetwarzania pełny zakres danych i metadanych dotyczących Celów Zrównoważonego Rozwoju Agendy 2030 (z danymi dla Polski) oraz zestawu danych monitorujących zrównoważony rozwój na poziomie kraju.
Dane udostępniane są poprzez REST-owe API w formacie JSON. Poniższa lista opisuje usługi sieciowe udostępnione w ramach interfejsu API.

Limity i klucz API

Ze względów bezpieczeństwa na interfejs zostały nałożone limity zapytań. Użytkownicy anonimowi mogą wykonać do 60 zapytań w ciągu godziny. Dla użytkowników zarejestrowanych na platformie Github limit wynosi 5000 zapytań w ciągu godziny. Od użytkownika zarejestrowanego wymagany jest token (rodzaj hasła autoryzacyjnego), który można wygenerować w opcjach konta github. Token należy dodać do zapytania w sposób przedstawiony na poniższym przykładzie:

curl -H "Accept:application/vnd.github.v3.raw" -H "Authorization: token wygenerowany_token" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne/1/1-1-1.json"

Więcej informacji na ten temat można znaleźć na stronach:
help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
developer.github.com/v3/auth/

Kody odpowiedzi

Kod Opis Znaczenie
200 OK Sformułowane zapytanie jest prawidłowe
302 FOUND Żądany zasób jest chwilowo dostępny pod innym adresem a przyszłe odwołania do zasobu powinny być kierowane pod adres pierwotny
304 NOT MODIFIED Zawartość zasobu nie podległa zmianie według warunku przekazanego przez klienta
400 BAD REQUEST Nieprawidłowe zapytanie
401 UNAUTHORIZED Żądanie zasobu, który wymaga uwierzytelnienia
403 FORBIDDEN Serwer zrozumiał zapytanie, lecz konfiguracja bezpieczeństwa zabrania mu zwrócić żądany zasób
404 NOT FOUND Serwer nie odnalazł zasobu według podanego URL ani niczego co by wskazywało na istnienie takiego zasobu w przeszłości
406 NOT ACCEPTABLE Zażądany zasób nie jest w stanie zwrócić odpowiedzi mogącej być obsłużonej przez klienta według informacji podanych w zapytaniu
410 GONE Żądany zasób nie jest dłużej dostępny i nieznany jest jego ewentualny nowy adres URI
500 INTERNAL SERVER ERROR Serwer napotkał niespodziewane trudności, które uniemożliwiły zrealizowanie żądania
502 BAD GATEWAY Serwer otrzymał niepoprawną odpowiedź od serwera nadrzędnego i nie jest w stanie zrealizować żądania klienta
503 SERVICE UNAVAILABLE Serwer nie jest w stanie w danej chwili zrealizować zapytania klienta ze względu na przeciążenie
504 GATEWAY TIMEOUT Serwer nie otrzymał w ustalonym czasie odpowiedzi od wskazanego serwera

GET /api/v1/krajowe_metadane.json Pobierz metadane dla wszystkich wskaźników krajowych

Metoda pozwala na uzyskanie metadanych dla wszystkich wskaźników krajowych w języku polskim.

Parametry

Usługa nie przyjmuje parametrów wejściowych.

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe_metadane.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe_metadane.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/krajowe/lista.json Pobierz tytuły wskaźników krajowych

Metoda pozwala na uzyskanie tytułów wszystkich wskaźników krajowych w języku polskim.

Parametry

Usługa nie przyjmuje parametrów wejściowych.

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe/lista.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe/lista.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/krajowe_dane.json Pobierz dane dla wszystkich wskaźników krajowych

Metoda pozwala na uzyskanie danych dla wszystkich wskaźników krajowych w języku polskim.

Parametry

Usługa nie przyjmuje parametrów wejściowych.

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe_dane.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe_dane.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/globalne_metadane.json Pobierz metadane dla wszystkich wskaźników globalnych

Metoda pozwala na uzyskanie metadanych dla wszystkich wskaźników globalnych w języku polskim.

Parametry

Usługa nie przyjmuje parametrów wejściowych.

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne_metadane.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne_metadane.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/globalne/lista.json Pobierz tytuły wskaźników globalnych

Metoda pozwala na uzyskanie tytułów wszystkich wskaźników globalnych w języku polskim.

Parametry

Usługa nie przyjmuje parametrów wejściowych.

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne/lista.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne/lista.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/globalne_dane.json Pobierz dane dla wszystkich wskaźników globalnych

Metoda pozwala na uzyskanie danych dla wszystkich wskaźników globalnych w języku polskim.

Parametry

Usługa nie przyjmuje parametrów wejściowych.

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne_dane.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne_dane.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/krajowe/{cel}.json Pobierz wszystkie wskaźniki krajowe z danego celu

Metoda pozwala na uzyskanie danych oraz metadanych dla wszystkich wskaźników krajowych dla wybranego celu w języku polskim.

Parametry

Parametry Opis
cel numer celu w którym znajduje się wskaźnik ( od 1 do 17 )

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe/1.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe/1.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/globalne/{cel}.json Pobierz wszystkie wskaźniki globalne z danego celu

Metoda pozwala na uzyskanie danych oraz metadanych dla wszystkich wskaźników globalnych dla wybranego celu w języku polskim.

Parametry

Parametry Opis
cel numer celu w którym znajduje się wskaźnik ( od 1 do 17 )

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne/1.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne/1.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/krajowe/{cel}/{num}.json Pobierz wskaźnik krajowy

Metoda pozwala na uzyskanie danych oraz metadanych dla wybranego wskaźnika globalnego w języku polskim.

Parametry

Parametry Opis
cel numer celu w którym znajduje się wskaźnik ( od 1 do 17 )
num numer wskaźnika

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe/1/1-1-b.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/krajowe/1/1-1-b.json

Kod odpowiedzi

200

Odpowiedź

GET /api/v1/globalne/{cel}/{num}.json Pobierz wskaźnik globalny

Metoda pozwala na uzyskanie danych oraz metadanych dla wybranego wskaźnika globalnego w języku polskim.

Parametry

Parametry Opis
cel numer celu w którym znajduje się wskaźnik ( od 1 do 17 )
num numer wskaźnika

Typ treści odpowiedzi

Przykładowy Curl

curl -H "Accept:application/vnd.github.v3.raw" "https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne/1/1-1-1.json"

Przykładowy URL

https://api.github.com/repos/statisticspoland/sdg-indicators-pl/contents/api/v1/globalne/1/1-1-1.json

Kod odpowiedzi

200

Odpowiedź