← Trang chủ

Tài liệu lập trình viên

Tự động hoá tạo flipbook hàng loạt bằng API key. Tất cả endpoint dùng cùng base URL.

Base URL
http://localhost:24001

Xác thực

Gửi API key qua header:

Authorization: Bearer fk_xxxxxxxxxxxxxxxxxxxx

Lấy key tại /dashboard/api-keys

Endpoint chính

MethodPathMô tả
POST/api/v1/flipbooksTạo quyển mới
POST/api/v1/flipbooks/:id/upload-initXin URL upload PDF
POST/api/v1/flipbooks/:id/upload-finishBáo upload xong, render
GET/api/v1/flipbooks/:id/jobsTheo dõi tiến độ render
PATCH/api/v1/flipbooks/:id/style/effectĐổi hiệu ứng lật
GET/api/v1/flipbooks/:id/shareLấy link chia sẻ + QR
GET/api/v1/flipbooks/:id/statsLấy thống kê
GET/api/v1/public/flipbook/:codeLấy manifest công khai (không cần auth)

Webhook

Đăng ký webhook để nhận sự kiện:

  • flipbook.ready — khi render xong
  • flipbook.failed — khi render lỗi
  • lead.captured — khi có lead mới
  • view.threshold — đạt mốc lượt xem