For developers
Build flipbooks into your own software
Upload, publish, re-point and measure from code. Every key, webhook and assistant works through the same permissions your team uses in the workspace.
- API access from Pro
- MCP from Pro
- Standard Webhooks signatures
# Publish a document for everyone
curl -X PUT \
https://api.flipbird.io/api/v1/documents/$DOC/publication \
-H "Authorization: Bearer $FLIPBIRD_KEY" \
-H "Content-Type: application/json" \
-d '{"mode": "public"}'
# The link, its QR codes and every embed
# now show the new version. In a few lines
Embed it, call it, or ask for it
Everything you do in the workspace, you can do from your own software, or ask an assistant to do for you.
- A REST API with scoped keys and a browsable reference
- Signed webhooks in the Standard Webhooks format
- An embed SDK with page-turn and link-click events
- An MCP server that acts only with the permissions a person approves
Embed
<div id="catalogue"></div>
<script src="https://view.flipbird.io/embed.js"></script>
<script>
const book = FlipbirdEmbed.init({
element: "#catalogue",
publicId: "abcdefghjkmnpqrs",
});
book.on("pagechange", ({ pages }) => console.log(pages));
</script> REST
# Publish a document as an unlisted flipbook
curl -X PUT \
https://api.flipbird.io/api/v1/documents/$DOC/publication \
-H "Authorization: Bearer $FLIPBIRD_KEY" \
-H "Content-Type: application/json" \
-d '{"mode": "unlisted"}' MCP
# Connect Claude Code to your workspace
claude mcp add --transport http flipbird https://api.flipbird.io/mcp
# Then ask, in plain words:
> Publish the spring catalogue as unlisted
> and make a QR code that opens it. Webhook
// Verify a Flipbird webhook (Standard Webhooks format)
const id = req.headers["webhook-id"];
const ts = req.headers["webhook-timestamp"];
const sig = req.headers["webhook-signature"]; // "v1,<base64>"
const key = Buffer.from(secret.replace("whsec_", ""), "base64");
const mac = crypto.createHmac("sha256", key)
.update(`${id}.${ts}.${rawBody}`)
.digest("base64");
const ok = sig.split(" ").includes(`v1,${mac}`)
&& Math.abs(Date.now() / 1000 - Number(ts)) < 300; What there is
Everything you need to automate publishing
-
REST API
Documents, uploads, publications, links, QR codes, exports, analytics, invites and the audit log, with a browsable reference.
-
Webhooks
Processed documents, finished exports, link clicks, paid invoices and low credit, signed and retried, with the same id on every retry.
-
Embed SDK
Put a flipbook in any page, then listen for page turns and link clicks, or turn to a page and search it from your own code.
-
MCP server
Let an assistant list, publish and export documents. A person approves it in the browser, and it never gets more than that person's permissions.
-
Keys and scopes
Each key carries only the scopes you give it, so a key that publishes needn't be able to delete. Revoke one at any time.
-
Single sign-on
SAML with Entra ID, Google Workspace, Okta or any SAML 2.0 provider, with step-by-step setup guides.
The API
What you can do from code
Routes are under https://api.flipbird.io/api/v1. A route outside a key's scopes answers 403, and a workspace whose plan has no API access gets 402.
Documents
- Resumable multipart uploads
- Versions, thumbnails and the source file
- Folders, tags and the trash
- Encryption on or off, per document
Publishing
- Public, unlisted, password or members only
- Search-engine title and description
- Rebuild a flipbook after a look changes
- Exports and their files
Links and QR codes
- Short links with rules by device, country and language
- QR codes as SVG or PNG, in your designs
- Links placed on a document's pages
- Scan and click counts
Analytics
- Workspace and per-document figures
- Views, readers and time on each page
- Link hits, downloads and embed loads
- QR analytics
Team
- Invites and members
- Sessions and API keys
- The audit log
- A copy of what's held about a member
Assets
- Images and their previews
- Fonts for the editor and flipbooks
- Text recognition (OCR) jobs
- Storage used
Questions
Developer questions
Which plans include the API?
API keys and the MCP server come with Pro and above. The embed works on every plan.
How are webhooks signed?
In the Standard Webhooks format: an HMAC-SHA256 over the event id, a timestamp and the body, so any Standard Webhooks library can verify them and refuse a replayed delivery.
Can an AI assistant do anything in my workspace?
Only what the person who approved it can do, and only what the plan allows. Tools that delete or overwrite ask for an explicit confirmation.
Start building today
Create a free workspace, then move up to Pro when you're ready for API keys.