Files

T

john-okeefe 26f1f98736 docs(kobo): mark native Kobo sync as coming soon

Native Kobo sync is implemented server-side but not yet supported on
real devices, so stop documenting it as a working feature.

- Rewrite kobo-setup.md as a coming-soon stub: point users to KOReader
  (which runs on Kobo hardware) as the supported path today, and list
  what native sync will deliver when released
- Add 'Coming Soon' status banners to the Kobo protocol spec, all five
  Kobo endpoint docs, and both API references, noting the endpoints are
  under active development and may change
- Tag the device shelf endpoints as pending native Kobo support

2026-08-20 14:14:43 -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/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/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