John O'Keefe
25ef0d12ba
Kobo emulation + KOReader calibre-compatible surface backfilled with
device-token auth; collections reorder + update_rule created.
Claude registry: 12 entries. kobo/koreader emulation endpoints all bind
arbitrary protocol POST bodies (markup/bookmark/gettests/sync-from-server,
koreader progress/bookmarks) — registered as AnyJSONObject, not bodyless as
first drafted. Initialization returns the library sync payload, not the init
response.
Contract correction in update_rule.md: the route is SetRuleEnabled ({enabled}
required -> {collection_id, is_smart}); Beam's draft invented rule-field
updates. Reordered response/status: {item_ids} -> {status: reordered}.
make test 9/9.
58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
---
|
|
method: GET
|
|
path: /api/sync/kobo/:token/v1/initialization
|
|
auth: device-token
|
|
area: kobo
|
|
---
|
|
<!-- source: internal/handlers/kobo.go:282 KoboHandler.Initialization -->
|
|
|
|
# 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
|
|
|
|
```http
|
|
GET /api/sync/kobo/:token/v1/initialization
|
|
X-Device-ID: 550e8400-e29b-41d4-a716-446655440000
|
|
X-Device-Key: device-auth-key
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json example-response
|
|
{
|
|
"last_sync": null,
|
|
"library_sync": null,
|
|
"total_books": null
|
|
}
|
|
```
|
|
|
|
## 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.
|