ndst.online API

Dokumentacja

Czym jest API?

API powstało, by umożliwić natychmiastową synchronizację materiałów po dodaniu do bazy. Oficjalna strona ndst.online pobiera dane właśnie z tego API, ale nic nie stoi na przeszkodzie, byś użył tego skryptu w swoim projekcie i generował dynamicznie dane. Dzięki temu możesz utworzyć na przykład całkowicie nową wersję strony bez powielania kodu HTML, lub stworzyć coś bardziej kreatywnego - na przykład widget lub bota wysyłającego nowe materiały na grupę Messenger. Aby korzystać z możliwości API wystarczy podstawowa znajomość JavaScript.

Budowa API

Wywołanie następuje za pomocą obiektu ndst

Podstawowym elementem niniejszego API jest obiekt content. W obiekcie content znajdują się odpowiednie szyki danych, z których możesz pobrać dane. Każda nazwa adekwatna jest do nazwy przedmiotu.

Obecnie dostępne są nastepujące szyki: utk1, eutk1, eutk2, aso1, aso2, math1, math2, jang2, jpol2, jhis2, lsk2, dg2, wiai2, so2.

Materiały dostępne w API (pobierane w formie obiektów), mają nastepujące zmienne: filename, filetype, title. Pliki graficzne posiadają dodatkowo zmienną description, którą mozna wykorzystać na przykład podczas tworzenia dynamicznej galerii zdjęć. Część plików posiada także zmienną shortcut, która zawiera skrótowe informacje na przykład na temat konkretnego pojęcia lub odnośnika. Istnieje też globalna zmienna ccloudserver, która umożliwia uzyskanie linku HTTPS do serwera CDN, który z kolei zapewnia dostęp do plików wyszczególnionych w API.

Getting started

Aby rozpocząć korzystanie z API należy umieścić odnośnik do serwera na końcu Twojego pliku HTML, ale pamiętaj, że ten skypt musi być umieszczony najwyżej, przed wszystkimi innymi skryptami.

Potrzebujesz wersji JSON? [w tym przypadku pomiń samouczek] Użyj tego kodu:

Składnia

Podstawowym elementem jest wspomniany wcześniej obiekt ndst oraz content. Aby dostać się do konkretnego szyku, należy wpisać: ndst.content.nazwa_szyku, gdzie nazwa szyku to oczywiście jedna z wyżej wymienionych nazw (patrz - budowa API). Dla przykładu, tak oto możesz wyświetlić w konsoli przeglądarki zawartość szyku utk1:

Przykłady użycia

Gdy znasz podstawy JavaScript, użycie API jest bardzo proste.

Dla przykładu, wygenerujmy listę materiałów z EUTK z klasy drugiej za pomocą pętli forEach dostępnej w JavaScript.

Łatwe jest też wyświetlanie ilości materiałów w bazie, oto przykład:

Możesz też oczywiście w łatwy sposób wygenerować link do każdego materiału, w tym przypadku wybraliśmy jeden z wielu dostępnych w eutk2:

W łatwy sposób możesz też zdefiniować zachowanie dla konkretnego typu pliku za pomocą instrukcji if. Poniżej przykład dla obrazka znajdującego się w kolekcji utk1.

Co dalej?

Sugeruję zapoznać się z dokumentacją i wykorzystać API do nauki!

Możesz też utworzyć serwer lustrzany, pobierając plik API, i umieszczając go na swoim serwerze. Pamiętaj, że zmiany w takim przypadku nie będą automatycznie pobierane.

Made with and by Mateusz Rojek