{% 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 %}
  <h1>API</h1>

  <div class="normal-text white-box">
    <p>
      {% url "api" as u %}
      {% blocktrans trimmed with u=u|build_absolute_uri:request %}
        API serwisu WolneLektury.pl znajduje się pod adresem <code>{{ u }}</code>.
        Za jego pomocą można uzyskać informacje o utworach, ich fragmentach
        i metadanych.
      {% endblocktrans %}
    </p>

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

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

    <ul>
      <li><a href='{% url "catalogue_api_book_list" "" %}'>
        {% url "catalogue_api_book_list" "" %}</a> – {% trans "Wszystkie utwory" %}</li>
      <li><a href='{% url "catalogue_api_audiobook_list" "" %}'>
        {% url "catalogue_api_audiobook_list" "" %}</a> – {% trans "Audiobooki" %}</li>
      <li><a href='{% url "catalogue_api_daisy_list" "" %}'>
        {% url "catalogue_api_daisy_list" "" %}</a> – {% trans "DAISY" %}</li>

      <li><a href='{% url "catalogue_api_tag_list" "author" %}'>
        {% url "catalogue_api_tag_list" "author" %}</a> – {% trans "Lista autorów" %}</li>
      <li><a href='{% url "catalogue_api_tag_list" "epoch" %}'>
        {% url "catalogue_api_tag_list" "epoch" %}</a> – {% trans "Lista epok" %}</li>
      <li><a href='{% url "catalogue_api_tag_list" "genre" %}'>
        {% url "catalogue_api_tag_list" "genre" %}</a> – {% trans "Lista gatunków literackich" %}</li>
      <li><a href='{% url "catalogue_api_tag_list" "kind" %}'>
        {% url "catalogue_api_tag_list" "kind" %}</a> – {% trans "Lista rodzajów literackich" %}</li>

      <li><a href='{% url "catalogue_api_tag_list" "theme" %}'>
        {% url "catalogue_api_tag_list" "theme" %}</a> – {% trans "Lista motywów i tematów literackich" %}</li>
      <li><a href='{% url "catalogue_api_collections" %}'>
        {% url "catalogue_api_collections" %}</a> – {% trans "Kolekcje" %}</li>
    </ul>

    <p>
      {% 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 %}
      <a href="{{e1}}">{{e1}}</a> {% trans "albo" %}
      <a href="{{e2}}">{{e2}}</a>.
    </p>

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

    <p>
      {% 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 %}
      <a href="/api/authors/adam-mickiewicz/kinds/liryka/parent_books/">/api/authors/adam-mickiewicz/kinds/liryka/parent_books/"</a>.
    </p>

    <p>
      {% blocktrans trimmed %}
        W ten sam sposób, filtrując dodatkowo według lektur lub motywów, można
        wyszukiwać fragmenty:
      {% endblocktrans %}
      <a href="/api/authors/william-shakespeare/themes/zabawa/fragments/">/api/authors/william-shakespeare/themes/zabawa/fragments/</a>.
      {% 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 %}
      <a href="{{f}}">{{f}}</a>.
    </p>
  </div>
{% endblock %}
