Skip to content

API to retrieve ZIM view + download URLs #137

@benoit74

Description

@benoit74

Zimfarm will need to get ZIM view + download URLs

Per collection, CMS will provide one view URL (kiwix-serve) and one download URL (file access through HTTP).

Since a given ZIM can be in a multiple collections, we will end up with a list of URLs, each with a kind (download or view).

We need a new API for that. Zimfarm can probably send a list of ZIM UUIDs and CMS will reply with details for each ZIMs.

CMS will build URLs based on a configuration stored at the collection level (using subpath of title in the collection if any + filename + ZIM filename + ZIM filename without suffix).

  • current prod download URL: https://download.kiwix.org/zim/{subpath}{filename_with_suffix}
  • current prod view URL: https://browse.library.kiwix.org/viewer#{filename_without_suffix}/

Note that the collection download URL will be used as well to build the collection catalog.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions