Documentation — ShoPublish

Getting Started

ShoPublish lets you upload PDFs, EPUBs, and other documents and instantly generate shareable flipbook links. Here's how to get up and running in minutes:

Create an account — Sign up for free with your email or Google account.
Upload a book — Click "Upload" on your dashboard to add a PDF, EPUB, or other supported file.
Share the link — Each book gets a unique URL like https://shopublish.com/read/my-book. Share it anywhere.
Customize — Edit the title, upload a cover image, set the background, or add password protection.

Supported File Formats

Format	Extension	Viewer
PDF Documents	.pdf	Page-flip flipbook with zoom
EPUB Books	.epub	Reflowable reader with ToC
Word Documents	.docx	Formatted document viewer
Presentations	.pptx	Slide viewer
Spreadsheets	.xlsx, .csv	Table viewer
Plain Text	.txt	Text reader
Images	.png, .jpg, .gif, .svg, .webp	Image viewer

Your Bookstore

Every ShoPublish user gets a public bookstore at https://shopublish.com/store/your-handle. You can customize it with:

Store name & logo — Brand your bookstore
Description — Tell visitors what your store is about
Themes — Choose from Magazine, Minimal, or Dark Luxe layouts
Custom domain (Pro+) — Point your own domain to your store
Privacy & Terms pages — Add legal pages to your store

Book Settings

Each book can be customized through the dashboard:

Setting	Description	Plan
Title & Slug	Custom URL-friendly name	All
Cover Image	Custom cover for store display	All
Background	Custom viewer background color	Basic+
Public/Private	Control visibility	All
Password	Protect content with a password	Pro+
Custom Domain	Serve book on your own domain	Pro+

API Reference

ShoPublish provides a REST API for Business plan users. Full interactive documentation is available at Swagger UI.

Authentication

All API requests require an API key sent in the Authorization header:

Authorization: Bearer your-api-key-here

Generate your API key from Dashboard → Settings → API Access.

Key Endpoints

POST /api/auth/login Authenticate and get a session token

GET /api/auth/me Get current user profile

GET /api/user/books List all your books

POST /api/user/books Upload a new book

PATCH /api/user/books/:id Update book metadata

DELETE /api/user/books/:id Delete a book

GET /api/user/analytics Get view analytics data

GET /api/user/activity Get activity log

For complete request/response schemas, visit the Swagger documentation.

Team Members

Pro and Business plans support team collaboration:

Invite members — Send email invitations from Dashboard → Members
Roles — Members can view your store and access shared books
Limits — Pro allows up to 50 members, Business is unlimited

Billing & Plans

View and manage your subscription from Dashboard → Settings → Subscription. Compare all plans on the Pricing page.

All prices are in USD
10% GST applies for Australian customers
Annual plans save you 2 months compared to monthly billing
14-day money-back guarantee on first-time paid subscriptions

Need Help?

Can't find what you're looking for? Visit our Contact page or email support@adhirat.com.