Difference between revisions of "OPDS"
Jump to navigation
Jump to search
(→End points: Complete OPDS documentation) |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Kiwix-serve]] provides an | [[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. | ||
A live instance can be see at https://library.kiwix.org/. | |||
== End points == | == End points == | ||
* https://library.kiwix.org/searchdescription.xml which proposes an overall OPDS description in XML format | * [https://library.kiwix.org/catalog/searchdescription.xml 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: | ||
** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue | ** <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). | ** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata). | ||
* | ** <code>tag=wikipedia</code> to filter on tags (multiple values as intersection). | ||
** <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 | |||
== See also == | == See also == | ||
Revision as of 19:49, 17 May 2020
Kiwix-serve provides an OPDS feed. This API allows to retrieve the library metadata, but not the content themselves.
A live instance can be see at https://library.kiwix.org/.
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:
q=<PATTERN>which proposes a keyword based search in the catalogue (on title and description).lang=frawhich proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).tag=wikipediato filter on tags (multiple values as intersection).count=2to limit the number of results.start=1to indicate an offset in search results.
- https://library.kiwix.org/catalog/root.xml which proposed the index of all the books