Files

T

john-okeefe d43bd9526b docs(api): add WebSocket real-time sync API documentation

- sync_api.md - Comprehensive WebSocket API guide

Covers:
- Connection and authentication (JWT + device)
- Client→Server messages (subscribe, ping)
- Server→Client messages (progress, conflicts, scan status, etc.)
- Message formats with examples
- Connection lifecycle
- Topics: progress, conflicts, scanner, devices, queue
- JavaScript usage example with reconnection
- Best practices for heartbeat and error handling

Documents bidirectional real-time sync API

2026-02-08 12:38:50 -05:00

1.0 KiB

Raw Blame History

Get Library

Get library metadata for KOReader device.

Endpoint: GET /api/sync/koreader/library Auth: Required (Device authentication)

Device Authentication

This endpoint requires device authentication (not user JWT). Devices authenticate using their device credentials.

Request Headers

Header	Type	Required	Description
X-Device-ID	string	Yes	Device UUID
X-Device-Key	string	Yes	Device authentication key

Example Request

GET /api/sync/koreader/library
X-Device-ID: 550e8400-e29b-41d4-a716-446655440000
X-Device-Key: device-auth-key

Response (200 OK)

{
  "books": [
    {
      "id": "uuid",
      "title": "Book Title",
      "authors": ["Author Name"],
      "file": "book.epub",
      "size": 1234567
    }
  ],
  "total": 42
}

Error Responses

Code	Description
401	Device authentication failed
404	Device not found

1.0 KiB Raw Blame History