john-okeefe
4d321528b2
This commit updates all documentation files throughout the project: - Updated IMPLEMENTATION_PLAN.md with new implementation details - Updated PROJECT_GUIDELINES.md with coding standards and practices - Updated README.md with current project information - Updated SCREENSHOT_AUTOMATION.md with new automation details - Added TEST_DATA.md with test fixtures data - Updated cover_image_serving_plan.md with static URL patterns Documentation API updates: - Updated API reference documentation for all endpoints including: - Authentication (login, logout, register, refresh_token) - Book matching (auto_link, bulk_link, link_book, search) - Collections (CRUD operations, shelf mappings, auto-assign rules) - Conflicts (bulk operations, resolve/dismiss) - Devices (registration, approval, shelf management) - Highlights (create, update, delete, get) - Kobo sync (bookmark, markup, initialization, sync) - KOReader sync (library, metadata, bookmarks, progress) - Libraries (CRUD, folders, media items, stats) - Media items (bulk operations, CRUD) - Notes (CRUD operations) - OPDS (acquisition, feeds, publication) - Progress (reading progress tracking) - Queue (device queue management) - Ratings (star ratings) - Scanner (watch mode, scan operations) - Sync protocols (Kobo, KOReader) - Users (profile, password, admin operations) - WebSocket protocols - Updated user guides (admin, dashboard, settings, sync) - Updated device setup guides (Kobo, KOReader) - Updated developer guides (testing, contributing, operations) - Updated scripts/README.md
100 lines
2.5 KiB
Markdown
100 lines
2.5 KiB
Markdown
# Kobo Sync Protocol
|
|
|
|
Kobo uses a proprietary sync protocol with JSON payloads.
|
|
|
|
## Kobo Markup Sync
|
|
|
|
**Endpoint**: `POST /api/sync/kobo/markup`
|
|
**Auth**: Device token required
|
|
**Content-Type**: `application/json`
|
|
|
|
### Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
| ------------- | ------ | -------- | ------------------- |
|
|
| Authorization | string | Yes | Bearer device token |
|
|
| x-kobo-device | string | Yes | JSON device info |
|
|
| Content-Type | string | Yes | application/json |
|
|
|
|
### Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
| ---------------------------------- | ------- | -------- | ------------------------------ |
|
|
| ReadingSync | array | No | Array of reading progress data |
|
|
| ReadingSync[].ContentId | string | Yes | Book UUID |
|
|
| ReadingSync[].PercentRead | float | Yes | Progress percentage (0-100) |
|
|
| ReadingSync[].EntitlementId | string | Yes | Kobo entitlement ID |
|
|
| ReadingSync[].RemainingTimeMinutes | integer | No | Estimated remaining time |
|
|
| ReadingSync[].LastModified | string | Yes | ISO 8601 timestamp |
|
|
| BookmarkSync | array | No | Array of bookmarks/highlights |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
POST /api/sync/kobo/markup
|
|
Authorization: Bearer device-token
|
|
x-kobo-device: {"DeviceId":"device-id","Model":"Kobo Clara"}
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"ReadingSync": [
|
|
{
|
|
"ContentId": "book-uuid",
|
|
"PercentRead": 45.6,
|
|
"EntitlementId": "entitlement-id",
|
|
"RemainingTimeMinutes": 120,
|
|
"LastModified": "2026-01-30T20:00:00Z"
|
|
}
|
|
],
|
|
"BookmarkSync": [
|
|
{
|
|
"ContentId": "book-uuid",
|
|
"BookmarkText": "highlighted text",
|
|
"BookmarkType": "annotation",
|
|
"BookmarkTitle": "Chapter 3"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"Status": "Success",
|
|
"MarkupsSynced": 5,
|
|
"BookmarksSynced": 3
|
|
}
|
|
```
|
|
|
|
## Kobo Library Fetch
|
|
|
|
**Endpoint**: `GET /api/sync/kobo/library`
|
|
**Auth**: Device token required
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/sync/kobo/library
|
|
Authorization: Bearer device-token
|
|
```
|
|
|
|
### Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"library_sync": [
|
|
{
|
|
"ContentId": "book-uuid",
|
|
"ContentType": "6",
|
|
"Title": "Book Title",
|
|
"Author": "Author Name",
|
|
"PercentRead": 42.3,
|
|
"PagesRemaining": 115,
|
|
"BookmarkCount": 3,
|
|
"LastModified": "2026-01-30T20:00:00Z"
|
|
}
|
|
]
|
|
}
|
|
```
|