0 Fork 0

Files

T

John O'Keefe 50282895f5 fix(docs): Work Order 2 — correct stale paths (11 docs + 3 Bruno)

Fix all wrong-path artifacts identified by the audit:
- Kobo sync endpoints (init/bookmark/markup/sync-from-server/analytics): add
  missing :token device segment (6 doc files incl. kobo-protocol.md)
- Highlights/notes update+delete: add missing /:id media-item prefix
- media-items/download_media_item.md: removed (static /uploads route, not an
  API endpoint; info about the file route is recoverable from OPDS docs)
- Bruno: /libraries/visible -> /visibility, /collections/books missing id,
  /audio/0 -> track_index
- operations/troubleshooting.md: same /libraries/visible -> /visibility fix
- media-items/get_audio_track.md + get_audio_chapters.md: /audio/0 examples fixed
- Deleted monolithic docs/developer/api-reference.md (duplicate of split docs)
- Fixed 4 stale entries in docs/developer/api/api-reference.md (split index)

Audit re-run: orphan docs 0, orphan Bruno 6 (all scenario files with literal IDs).

2026-10-24 14:44:19 -04:00

1.5 KiB

Raw Blame History

Kobo Initialization

Status: Coming Soon — Native Kobo sync is not yet supported on real devices; this endpoint is under active development and may change.

Initialize Kobo device sync.

Endpoint: GET /api/sync/kobo/:token/v1/initialization Auth: Required (Device authentication)

Device Authentication

This endpoint requires device authentication (not user JWT). Kobo devices authenticate using their device credentials and access tokens.

Request Headers

Header	Type	Required	Description
X-Device-ID	string	Yes	Device UUID
X-Device-Key	string	Yes	Device authentication key
X-Kobo-UserKey	string	No	Kobo user key (if available)

Example Request

GET /api/sync/kobo/:token/v1/initialization
X-Device-ID: 550e8400-e29b-41d4-a716-446655440000
X-Device-Key: device-auth-key

Response (200 OK)

{
  "result": "ok",
  "resources": {
    "image_host": "https://cdn.kobo.com/...",
    "image_url_quality_template": "{ImageId}/h270/{ImageId}_landscape_cover.jpg"
  }
}

Error Responses

Code	Description
401	Device authentication failed
404	Device not found

Notes

This endpoint is called by Kobo devices during initial setup and connection. It returns configuration data required for proper Kobo integration.

1.5 KiB Raw Blame History