Universal Bookshelf Documentation

Complete guide to building with our e-commerce platform for books

Everything you need to integrate with our platform, from authentication and API endpoints to webhooks and advanced features.

Quick Start

1. Get API Keys

Sign up for an account and generate your API keys from the dashboard.

Authentication Guide

2. Make Your First Request

Test the API with our interactive examples and test endpoints.

API Examples

Core Documentation

Authentication

Learn about JWT authentication, user management, and security best practices.

  • JWT Token Management
  • User Registration & Login
  • Password Reset
  • Social Login (OAuth)
View Guide

Social Login

Integrate Google and Facebook OAuth for seamless user authentication.

  • Google OAuth Setup
  • Facebook OAuth Setup
  • User Profile Management
  • Security Best Practices
View Guide

Password Reset

Secure password reset functionality with email verification and token management.

  • Secure Token Generation
  • Email Templates
  • Rate Limiting
  • Security Considerations
View Guide

Rate Limiting

Protect your API with configurable rate limiting and monitoring.

  • Configurable Limits
  • User-based Limits
  • Monitoring & Analytics
  • Best Practices
View Guide

Webhooks

Real-time notifications for platform events with secure delivery and retry logic.

  • Event Notifications
  • Secure Delivery
  • Retry Logic
  • Monitoring & Logs
View Guide

E-commerce

Complete e-commerce system for selling books with shopping cart, checkout, and order management.

  • Shopping Cart Management
  • Checkout Process
  • Payment Processing
  • Order Management
View Guide

API Reference

Complete API documentation with examples, response formats, and error handling.

  • All Endpoints
  • Request/Response Examples
  • Error Codes
  • Testing Tools
View Reference

API Overview

Base URL

https://yourdomain.com/api

Authentication

All protected endpoints require a Bearer token in the Authorization header:

Authorization: Bearer <your_jwt_token>

Response Format

All API responses follow a consistent JSON format:

{ "status": true, "message": "Success message", "data": { ... } }

Rate Limits

  • Authentication: 5 requests/minute
  • API Endpoints: 60 requests/minute
  • File Uploads: 10 requests/minute

Available APIs

User Management
Stable

Complete user lifecycle management including registration, authentication, and profile management.

  • User registration and login
  • Profile management
  • Password reset
  • Social login integration
Book Management
Stable

Comprehensive book management system for authors and publishers.

  • Book creation and updates
  • Format management (eBook, Paperback, Hardcover)
  • Content moderation
  • ISBN management
E-commerce
Stable

Full e-commerce functionality for selling books and managing orders.

  • Shopping cart and wishlist
  • Order management
  • Payment processing
  • Invoice generation
Royalty System
Beta

Advanced royalty management for authors and publishers.

  • Customizable royalty rates
  • Multi-format support
  • Regional pricing
  • Payout management

Getting Help

Documentation

Browse our comprehensive guides and API reference.

Code Examples

Working examples in multiple programming languages.

Support

Contact our development team for assistance.