John O'Keefe
4ab6a64bd8
The explorer page was never routed and its client module is removed in the preceding refactor; the endpoint docs render examples statically.
3.1 KiB
3.1 KiB
Developer Documentation
Welcome to the Bookhoard developer documentation. This section contains API references, protocol specifications, and technical documentation for integrating with Bookhoard.
📚 API Documentation
Complete API Reference
- API Reference - Complete REST API reference
- Authentication
- User management
- Libraries
- Media items
- Reading progress
- Notes & highlights
- Analytics
- Book matching
- OPDS
- Sync protocols (KOReader, Kobo)
- WebSocket
Split Endpoint Documentation
Browse individual endpoint documentation:
- API Documentation - Split endpoint docs
- Authentication - Register, login, tokens
- Users - Profile management
- Libraries - Library operations
- Media Items - Book/ebook management
- Progress - Reading progress tracking
- Notes - User notes
- Highlights - Book highlights
- Ratings - Book ratings
- Devices - Device management
- Analytics - Usage statistics
- Book Matching - Search and link books
- Collections - Collection management
- OPDS - Open Publication Distribution
- Sync Protocols - KOReader and Kobo sync
- WebSocket - Real-time events
Collections API
- Collections API - Complete collections API reference
- Create and manage collections
- Auto-assign rules
- Test rules
- Bulk operations
- Device shelf mappings
🔌 Protocol Specifications
Sync Protocols
-
Kobo Sync Protocol - Kobo device sync protocol
- Kobo markup sync
- Library fetch
- Authentication
-
KOReader Sync Protocol - KOReader sync protocol
- Progress sync
- Metadata fetch
- Conflict handling
WebSocket Protocol
- WebSocket API - Real-time sync and events
- Connection flow
- Message format
- Event types
- Authentication
🛠 Implementation Guides
Library Visibility
- Library Visibility - Per-user library visibility: the family-lens rule. New media endpoints MUST thread the visible-library set (helpers, SQL pattern, series per-library).
Calibre Integration
- Calibre OPF Implementation - Technical implementation details
- Architecture and design
- Data structures and functions
- Database schema mapping
- Testing strategy
- Error handling
- Performance considerations
Looking for user documentation? See the User Portal Need to deploy? See the Operations Portal