Files

T

john-okeefe efa046d030 docs: add ratings, devices, and analytics API endpoints

Phase 2 part 5: Split device management and analytics endpoints
- Ratings: get_ratings, create_rating (1-10 scale with half-stars)
- Devices: register_device, list_devices, get_devices, revoke_device
- Analytics: get_analytics (reading statistics)
- Include device registration flow details

2026-02-02 08:51:53 -05:00

1.4 KiB

Raw Blame History

Get Device / Check Registration Status

Check device registration status or get device details.

Endpoint: POST /api/devices/auth/status or GET /api/devices/{device_id} Auth: Not required for status check, Required for device details Content-Type: application/json (for status check)

Request Body (Status Check)

Field	Type	Required	Description
registration_id	string	Yes	Registration UUID

Example Request (Status Check)

{
  "registration_id": "registration-uuid"
}

Response (200 OK)

{
  "status": "pending|approved|expired",
  "auth_token": "device-bearer-token...",
  "device_id": "uuid",
  "sync_endpoints": {
    "progress": "https://bookhoard.com/api/sync/progress",
    "metadata": "https://bookhoard.com/api/sync/metadata",
    "annotations": "https://bookhoard.com/api/sync/annotations"
  }
}

Response (200 OK) - Device Details

{
  "id": "uuid",
  "device_name": "My Kobo Clara",
  "device_type": "kobo",
  "last_sync": "2026-01-31T10:00:00Z",
  "last_seen": "2026-01-31T10:05:00Z",
  "sync_enabled": true,
  "auto_sync": true,
  "sync_frequency_minutes": 5
}

Error Responses

Code	Description
401	Invalid or expired token (for device details)
404	Device or registration not found

1.4 KiB Raw Blame History