Narzędzia użytkownika

Narzędzia witryny


api_http

API HTTP bazy

Baza udostępnia proste API HTTP umożliwiające:

  • wyszukiwanie szkół;
  • wyszukiwanie jednostek samorządu terytorialnego (JST);
  • wyszukiwanie wskaźników;
  • pobieranie danych EWD/PWE;
  • generowanie wykresów EWD/PWE w formatach SVG i PNG.

Wszystkie argumenty wywołania API przekazywane są przez adres zapytania HTTP GET,

Nie ma potrzeby autoryzacji, przesyłania specjalnych nagłówków, itp.

Z wyjątkiem akcji generujących wykresy API zwraca kod JSON.

API dostępne jest pod adresem http://api.ewd.edu.pl

Korzystanie z API

Typowy schemat korzystania z API to:

  • wyszukanie szkół i/lub JST za pomocą akcji: zwrSzkoly, zwrGminy, zwrPowiaty, zwrWojewodztwa,
  • wyszukanie wskaźników dostępnych dla danych szkół i/lub JST za pomocą akcji zwrWskazniki (z odpowiednio ustawionymi parametrami idSzkol i/lub idJST),
  • pobranie wartości wskaźników i/lub wykresów za pomocą akcji: zwrDanePWE, zwrDaneEWD, zwrWykresPWE, zwrWykresEWD.

Aby wywołać daną akcję w odpowiedni sposób, potrzeba zapoznać się z dostępnymi dla niej parametrami, co opisano poniżej.

Odczytywanie listy akcji

Aby uzyskać listę dostępnych akcji, wywołaj API z parametrem pomoc

http://api.ewd.edu.pl?pomoc=
[
   {
      "obowiazkowy" : true,
      "typ" : "string",
      "wartDomyslna" : null,
      "nazwa" : "akcja",
      "opis" : "Akcja API",
      "wartosci" : [
         "zwrWskazniki",
         "zwrDanePWE",
         "zwrCSVPWE",
         "zwrWykresPWE",
         "zwrDaneAdrSzkoly",
         "zwrDaneEWD",
         "zwrWykresEWD",
         "zwrSzkoly",
         "zwrWojewodztwa",
         "zwrPowiaty",
         "zwrGminy"
      ]
   }
]

Ze zwróconego obiektu możemy dowiedzieć się, że API przyjmuje obowiązkowy parametr akcja oraz jakie może on przyjąć wartości.

Odczytywanie parametrów dostępnych dla danej akcji

Aby dowiedzieć się, jakie parametry przyjmuje dana akcja, należy wywołać API ze wskazaną akcją oraz parametrem pomoc, np.:

http://api.ewd.edu.pl?akcja=zwrWskazniki&pomoc=

W wyniku otrzymujemy opis wszystkich dostępnych parametrów. Z uwagi na jego długość, poniżej zamieszczono tylko początek

[
   {
      "wartosci" : [
         "ewd",
         "pwe"
      ],
      "wartDomyslna" : null,
      "typ" : "string",
      "opis" : "rodzaj wskaźnika",
      "nazwa" : "rodzajWsk",
      "obowiazkowy" : false
   },
   {
      "nazwa" : "doPrezentacji",
      "obowiazkowy" : false,
      "wartDomyslna" : null,
      "typ" : "bool",
      "opis" : "czy tylko wskaźniki do publicznej prezentacji/ukryte",
      "wartosci" : null
   },
   (...)
]

Przykłady w językach programowania

Jako przykład wykorzystane zostanie wywołanie akcji zwrWskazniki z parametrami:

  • doPrezentacji równym 1;
  • rodzajWsk równym pwe;

http://api.ewd.edu.pl?akcja=zwrWskazniki&doPrezentacji=1&rodzajWsk=ewd

jQuery

var param = {
  akcja: 'zwrWskazniki',
  doPrezentacji: 1,
  rodzajWsk: 'pwe'
}
$.getJSON('http://api.ewd.edu.pl', param, function(dane){
   ...tu wpisz kod obsługi danych...
});

PHP

$url = http_build_query(array(
  'akcja' => 'zwrWskazniki',
  'doPrezentacji' => 1,
  'rodzajWsk' => 'pwe'
));
$dane = json_decode(file_get_contents('http://api.ewd.edu.pl?' . $url));

R

W R najłatwiej użyć pakietów httr oraz jsonlite.

library(httr)
library(jsonlite)
dane = GET(
  'http://api.ewd.edu.pl', 
  query = list(
    akcja = 'zwrWskazniki',
    doPrezentacji = 1,
    rodzajWsk = 'pwe'
  )
)
dane = content(dane, 'parsed')
api_http.txt · ostatnio zmienione: 2015/06/02 21:04 przez zozlak