john-okeefe
b44e4e4709
Clean up API documentation files by removing Phase X references: Remove 'API Explorer will be inserted here in Phase X' placeholders from: - 70+ API endpoint documentation files - Authentication endpoints (login, logout, register, refresh) - User endpoints (profile, settings, password) - Device endpoints (registration, sync, shelves) - Library endpoints (CRUD, folders, visibility) - Media endpoints (items, progress, highlights, notes) - Admin endpoints (users, analytics) - Sync endpoints (Kobo, KOReader) - OPDS endpoints - Scanner endpoints - Queue endpoints These placeholders were from planning documents and have no meaning to API consumers. The documentation is now clean and ready for use.
50 lines
1.2 KiB
Markdown
50 lines
1.2 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.
|