Difference between revisions of "OPDS"

Line 4:

== End points ==

* https://library.kiwix.org/catalog/searchdescription.xml ~~which proposes an overall OPDS description in XML format~~

* https://library.kiwix.org/catalog/~~search which~~ accepts ~~a few~~ GET ~~parameter~~:

=== /catalog/v2 ===

* https://library.kiwix.org/catalog/v2/root.xml lists all other /catalog/v2 endpoints.

* https://library.kiwix.org/catalog/v2/searchdescription.xml describes the /catalog/v2/entries endpoint.

* https://library.kiwix.org/catalog/v2/entries provides access to full entries. It accepts the following GET parameters:

** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue (on title and description).

** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).

Line 15:

Line 21:

** <code>count=2</code> to limit the number of results.

** <code>start=1</code> to indicate an offset in search results.

* https://library.kiwix.org/catalog/root.xml ~~which proposed the index of~~ all the books

* https://library.kiwix.org/catalog/v2/partial_entries provides access to partial entries. It accepts the same GET parameters as its full entry counterpart.

* https://library.kiwix.org/catalog/v2/categories provides access to entries grouped by category

* https://library.kiwix.org/catalog/v2/languages provides access to entries grouped by language

=== Legacy endpoint ===

* https://library.kiwix.org/catalog/root.xml lists all books.

* https://library.kiwix.org/catalog/searchdescription.xml describes the /catalog/search endpoint.

* https://library.kiwix.org/catalog/search allows to filter books. It accepts the same GET parameters as /catalog/v2/entries (see above).

== See also ==

Difference between revisions of "OPDS"

Navigation menu

Search

@@ Line 4: / Line 4: @@
 == End points ==
-* https://library.kiwix.org/catalog/searchdescription.xml which proposes an overall OPDS description in XML format
-* https://library.kiwix.org/catalog/search which accepts a few GET parameter:
+=== /catalog/v2 ===
+* https://library.kiwix.org/catalog/v2/root.xml lists all other /catalog/v2 endpoints.
+* https://library.kiwix.org/catalog/v2/searchdescription.xml describes the /catalog/v2/entries endpoint.
+* https://library.kiwix.org/catalog/v2/entries provides access to full entries. It accepts the following GET parameters:
 ** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue (on title and description).
 ** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).
@@ Line 15: / Line 21: @@
 ** <code>count=2</code> to limit the number of results.
 ** <code>start=1</code> to indicate an offset in search results.
-* https://library.kiwix.org/catalog/root.xml which proposed the index of all the books
+* https://library.kiwix.org/catalog/v2/partial_entries provides access to partial entries. It accepts the same GET parameters as its full entry counterpart.
+* https://library.kiwix.org/catalog/v2/categories provides access to entries grouped by category
+* https://library.kiwix.org/catalog/v2/languages provides access to entries grouped by language
+=== Legacy endpoint ===
+* https://library.kiwix.org/catalog/root.xml lists all books.
+* https://library.kiwix.org/catalog/searchdescription.xml describes the /catalog/search endpoint.
+* https://library.kiwix.org/catalog/search allows to filter books. It accepts the same GET parameters as /catalog/v2/entries (see above).
 == See also ==