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

API jest udostępniane w ogólnie przyjętym formacie danych JSON. Dzięki temu możliwe jest jego wykorzystanie w wielu językach programowania.

Sama struktura jest banalnie prosta: obiekt content zawierający tablice z materiałami z konkretnych przedmiotów.

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

Materiały dostępne w API, posiadają przypisane 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.

Aby uzyskać dostęp do pliku, którego nazwa została wskazana za pomocą zmiennej filename, nalezy użyć adresu serwera CDN https://cdn.czooosnek.cloud/files/[ZMIENNA FILENAME]

Getting started

Użyj poniższego odnośnika - dostarcza on dane w formacie JSON.

API ORIGIN | https://api.czooosnek.cloud/ndst.json

Nie wiesz, jak zacząć? Poniżej przykład w języku JS, wyświetlający zawartość API w konsoli deweloperskiej.

Składnia

Aby zobrazować dostęp do danych, do poprzedniego przykładu dodaj zmienną let o dowolnej nazwie, ja nazwę ją ndst.

Teraz bardzo łatwo uzyskać dostęp do danych. Wystarczy wydać polecenie wyświetlające zawartość zmiennej [jej typ to Object] - opcjonalnie można wskazać konkretną tablicę, jej index oraz parametr z wybranego materiału.

W ten sposób wyświetlisz materiały z lokalnych sieci komputerowych z drugiej klasy:

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 korzystając z ogólnodostępnych narzędzi.

Made with and by Mateusz Rojek