Lexicon Garden

org.passingreads.book.stashBookKey

Stash a book's private key on the appview so the user can interact with the book (drop it, leave a note) from any device without re-scanning the QR. Stashed keys are wiped automatically when a drop event is ingested for that book.

Repository @passingreads.org did:plc:oeipalbxet5jghoqe6b6ctu6 namespace authority
Details · procedure
Kindprocedure
Authoritybook.passingreads.org
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

bookId

requiredstring

The book's short ID (as encoded in its QR code).

privateKey

requiredstring

Multibase-encoded Ed25519 private key for the book. The appview verifies the key derives to the given bookId.

Output

application/json

stashedAt

requiredstring · datetime

Errors

BookKeyMismatch

The supplied privateKey does not derive to the supplied bookId.

ProfileNotFound

The authenticated DID has no PassingReads profile indexed by the appview.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • org.passingreads.book.listBookKeys

    query

    List the book private keys the authenticated user has stashed on the appview. Used by clients to populate the local key cache after sign-in on a new device.