← 首页

开发者文档

通过 API key 自动化创建 flipbook。所有 endpoint 共用同一 base URL。

Base URL
http://localhost:24001

认证

通过 header 发送 API key:

Authorization: Bearer fk_xxxxxxxxxxxxxxxxxxxx

在此获取 key: /dashboard/api-keys

主要 endpoint

方法路径说明
POST/api/v1/flipbooks创建新书
POST/api/v1/flipbooks/:id/upload-init获取 PDF 上传 URL
POST/api/v1/flipbooks/:id/upload-finish确认上传完成并开始渲染
GET/api/v1/flipbooks/:id/jobs查看渲染进度
PATCH/api/v1/flipbooks/:id/style/effect更改翻页特效
GET/api/v1/flipbooks/:id/share获取分享链接与 QR
GET/api/v1/flipbooks/:id/stats获取统计
GET/api/v1/public/flipbook/:code获取公开 manifest(无需认证)

Webhook

订阅 webhook 以接收事件:

  • flipbook.ready — 渲染完成时
  • flipbook.failed — 渲染失败时
  • lead.captured — 有新潜在客户时
  • view.threshold — 达到浏览次数阈值