Difference between revisions of "OPDS"

From Kiwix
Jump to navigation Jump to search
(→‎End points: Complete OPDS documentation)
(Put a pointer to the online documentation)
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Kiwix-serve]] provides an '''[https://en.wikipedia.org/wiki/OPDS OPDS]''' feed which allow to search through available content. A live instance can be see at https://library.kiwix.org/.
[[Kiwix-serve]] provides an [https://en.wikipedia.org/wiki/Open_Publication_Distribution_System OPDS] feed. This API allows to retrieve the library metadata, but not the content themselves.


== End points ==
A [https://kiwix-tools.readthedocs.io/en/latest/ full documentation of the OPDS API and other API offered by kiwix-serve is available online].
* https://library.kiwix.org/searchdescription.xml which proposes an overall OPDS description in XML format
 
* http://library.kiwix.org/catalog/search which accepts a few GET parameter:
A live instance can be see at https://library.kiwix.org/.
** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue
 
** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).
=== Legacy endpoint ===
* http://library.kiwix.org/catalog/root.xml which proposed the index of all the books
 
* https://library.kiwix.org/catalog/root.xml lists all books.
* https://library.kiwix.org/catalog/searchdescription.xml describes the <code>/catalog/search</code> endpoint.
* https://library.kiwix.org/catalog/search allows to filter books. It accepts the same GET parameters as <code>/catalog/v2/entries</code> (see above).


== See also ==
== See also ==

Latest revision as of 13:03, 19 February 2023

Kiwix-serve provides an OPDS feed. This API allows to retrieve the library metadata, but not the content themselves.

A full documentation of the OPDS API and other API offered by kiwix-serve is available online.

A live instance can be see at https://library.kiwix.org/.

Legacy endpoint

See also