User Tools

mbstring extension must be loaded in order to run mPDF

Latest documentation

Entities

Resource URI Version Links to Linked by
repositoryItems 1.1 fileResources, genre, subject, collection bookshelf, basicSearch
fileResources 1.1 - -
bookshelf 1.0 repositoryItems -
basicSearch 1.2 repositoryItems -
genres 1.0 - repositoryItems, basicSearch
subjects 1.0 - repositoryItems, basicSearch
collections 1.0 repositoryItems, basicSearch -
users 1.1 - -

Properties

Property Name Available From
Format formats repositoryItems, fileResources, bookshelf, basicSearch
File size filesize repositoryItems, fileResources, basicSearch
Signed download link s3_path_signed repositoryItems, fileResources, bookshelf
Cover Art cover_art repositoryItems, bookshelf?

HTTP Methods

  • All resources support GET, OPTIONS
  • bookshelf additionally supports POST (add to Bookshelf)

Auth endpoints

Auth* Resource URI Example
AuthN login-token GET /api/login-token
Authorization: Basic [:basic_auth_hash]
AuthZ refresh-token GET /api/refresh-token/[:refresh_token]
public/nnels/nnels_api_docs_v1/latest_resources.txt · Last modified: 2019/07/09 10:26 by jonathan.schatz