Dokumentasi API

Jana kunci di halaman Flipbook saya, kemudian hantar dalam pengepala Authorization: Bearer KUNCI pada setiap permintaan.

Sambung ke ChatGPT dan Claude (MCP)

flipbook.my boleh digunakan terus dari pembantu AI. Alamat pelayan ialah https://flipbook.my/mcp.

Claude: buka tetapan Connectors, tambah penyambung tersuai, tampal alamat itu dan log masuk.
ChatGPT: buka tetapan Apps & Connectors, tambah penyambung tersuai dengan alamat itu dan log masuk. Pilihan ini bergantung pada pelan ChatGPT anda.
Claude Code: claude mcp add --transport http flipbook https://flipbook.my/mcp

Klien yang tidak menyokong OAuth boleh menghantar kunci API dalam pengepala Authorization: Bearer KUNCI.

Contoh permintaan: "Jadikan PDF di pautan ini flipbook dengan kesan coverflow dan beri saya pautannya."

Alat: flipbook_create_from_url, flipbook_create_from_file (base64, sehingga 25 MB), flipbook_list, flipbook_get, flipbook_update, flipbook_delete, flipbook_restore, flipbook_stats, flipbook_leads.

Untuk fail besar, gunakan pautan terus. Pembantu AI mungkin tidak dapat menghantar kandungan fail lampiran sebagai base64, jadi sediakan pautan jika itu berlaku.

Cipta flipbook

curl -X POST https://flipbook.my/api/flipbooks \
  -H "Authorization: Bearer KUNCI" \
  -F "file=@katalog.pdf" \
  -F "title=Katalog 2027" \
  -F 'design={"effect":"coverflow","rtl":false}'

Respons 201 selepas pemprosesan selesai:

{
  "id": "a1b2c3d4e5f6",
  "title": "Katalog 2027",
  "numPages": 24,
  "width": 595,
  "height": 842,
  "published": true,
  "links": {
    "view": "https://flipbook.my/f/a1b2c3d4e5f6",
    "thumbnail": "https://flipbook.my/files/a1b2c3d4e5f6/thumb.jpg",
    "pdf": "https://flipbook.my/files/a1b2c3d4e5f6/doc.pdf",
    "oembed": "https://flipbook.my/oembed?url=…"
  }
}

Cipta daripada URL

curl -X POST https://flipbook.my/api/flipbooks/import \
  -H "Authorization: Bearer KUNCI" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://contoh.my/katalog.pdf","title":"Katalog","async":true}'

Dengan "async": true, respons 202 dikembalikan serta-merta. Semak state melalui GET /api/flipbooks/:id: processing, ready atau failed. Muat naik juga menerima DOCX dan PPTX jika penukar dipasang pada pelayan.

Titik akhir

Kaedah	Laluan	Fungsi
GET	`/api/flipbooks`	Senarai flipbook anda
GET	`/api/flipbooks/:id`	Butiran satu flipbook
PATCH	`/api/flipbooks/:id`	Kemas kini `title`, `subtitle`, `description`, `design`, `layers`, `published`, `password`, `allowedDomains`
DELETE	`/api/flipbooks/:id`	Padam flipbook
GET	`/api/flipbooks/:id/stats`	Statistik
GET	`/api/flipbooks/:id/leads`, `/leads.csv`	Senarai prospek
GET	`/api/flipbooks/:id/export.zip`	Salinan HTML untuk dihos sendiri
GET	`/api/trash`	Tong sampah
POST	`/api/trash/:id/restore`	Pulihkan flipbook
GET, POST	`/api/shelves`	Senarai atau cipta rak
PUT, DELETE	`/api/shelves/:id`	Kemas kini atau padam rak
GET	`/oembed?url=`	Kod benam oEmbed (tanpa kunci)

Reka bentuk

design.effect menerima magazine, book, album, notebook, slider, coverflow, cards atau onepage.

Benam dengan skrip

<div data-flipbook="ID" data-height="600"></div>
<script src="https://flipbook.my/embed.js" async></script>

Webhook prospek

Tetapkan URL https dalam editor. Setiap prospek baharu dihantar sebagai JSON, dengan sehingga tiga cubaan:

{ "type": "lead", "date": "2027-01-31T10:00:00.000Z",
  "flipbook": { "id": "a1b2c3d4e5f6", "title": "Katalog" },
  "lead": { "name": "Ali", "email": "ali@contoh.my", "phone": "" } }

Kawasan interaktif

Kedudukan x, y, w dan h ialah peratusan saiz halaman, jadi kekal tepat pada semua saiz skrin.

{ "layers": [
  { "type": "link",  "page": 2, "x": 10, "y": 70, "w": 30, "h": 6, "url": "https://contoh.my" },
  { "type": "page",  "page": 2, "x": 60, "y": 70, "w": 30, "h": 6, "target": 8 },
  { "type": "video", "page": 3, "x": 10, "y": 20, "w": 80, "h": 40, "url": "https://youtu.be/ID" }
] }

Jenis lain: audio, image dan web. Tambah "shape": "circle" untuk bulatan, "visible": true supaya kawasan sentiasa nampak, dan "label" untuk namanya dalam statistik.

Klik setiap pautan dan lompat halaman dikira. GET /api/flipbooks/:id/stats memulangkan areas, iaitu bilangan klik dan pelawat bagi setiap kawasan.