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
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
# Kobo Initialization
|
|
|
|
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
|
|
|
|
```http
|
|
GET /api/sync/kobo/v1/initialization
|
|
X-Device-ID: 550e8400-e29b-41d4-a716-446655440000
|
|
X-Device-Key: device-auth-key
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"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.
|