API

API serwisu WolneLektury.pl znajduje się pod adresem http://wolnelektury.pl/api/. Za jego pomocą można uzyskać informacje o utworach, ich fragmentach i metadanych.

Dane domyślnie są serializowane w formacie JSON, ale dostępny jest też format XML – wystarczy dodać parametr ?format=xml do każdego zapytania.

API Wolnych Lektur zawiera następujące adresy URL:

• /api/books/ – Wszystkie utwory
• /api/audiobooks/ – Audiobooki
• /api/daisy/ – DAISY
• /api/authors/ – Lista autorów
• /api/epochs/ – Lista epok
• /api/genres/ – Lista gatunków literackich
• /api/kinds/ – Lista rodzajów literackich
• /api/themes/ – Lista motywów i tematów literackich
• /api/collections/ – Kolekcje

Każdy element na tych listach zawiera adres (w atrybucie „href”), pod którym można znaleźć szczegółowe dane, np. /api/books/studnia-i-wahadlo/ czy /api/authors/edgar-allan-poe/.

Można łączyć autorów, epoki, gatunki i rodzaje, aby wybrać tylko utwory odpowiadające zadanym kryteriom. Na przykład: /api/authors/adam-mickiewicz/kinds/liryka/books/.

Aby spośród wszystkich pasujących wybrać tylko utwory najwyższego poziomu (pomijając ich podutwory), można użyć zapytania /parent_books/, np.: /api/authors/adam-mickiewicz/kinds/liryka/parent_books/.

W ten sam sposób, filtrując dodatkowo według lektur lub motywów, można wyszukiwać fragmenty:/api/authors/william-shakespeare/themes/zabawa/fragments/. Każdy element uzyskanej listy w atrybucie „href” zawiera link do szczegółowego opisu danego fragmentu, np.: /api/books/sen-nocy-letniej/fragments/1290526312912-3814598192/.