{% extends "base_simple.html" %} {% load i18n %} {% load build_absolute_uri from fnp_common %} {% block settings %} {% load title %} {% trans "API WolneLektury.pl" as title %} {% title title %} {% endblock %} {% block title %}{% trans "API WolneLektury.pl" %}{% endblock %} {% block bodyid %}api{% endblock %} {% block body %}

API

{% url "api" as u %} {% blocktrans trimmed with u=u|build_absolute_uri:request %} API serwisu WolneLektury.pl znajduje się pod adresem {{ u }}. Za jego pomocą można uzyskać informacje o utworach, ich fragmentach i metadanych. {% endblocktrans %}

{% blocktrans trimmed %} Dane domyślnie są serializowane w formacie JSON, ale dostępny jest też format XML – wystarczy dodać parametr ?format=xml do dowolnego zapytania. {% endblocktrans %}

{% blocktrans trimmed %} API Wolnych Lektur zawiera następujące adresy URL: {% endblocktrans %}

{% url "catalogue_api_book" "studnia-i-wahadlo" as e1 %} {% url "catalogue_api_tag" "author" "edgar-allan-poe" as e2 %} {% blocktrans trimmed %} Każdy element na tych listach zawiera adres (w atrybucie „href”), pod którym można znaleźć szczegółowe dane, np. {% endblocktrans %} {{e1}} {% trans "albo" %} {{e2}}.

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

{% blocktrans trimmed %} 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.: {% endblocktrans %} /api/authors/adam-mickiewicz/kinds/liryka/parent_books/".

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

{% endblock %}