How to Use the FlipLink API for Custom Integrations

If you're managing dozens (or hundreds) of flipbooks, doing everything manually through the dashboard gets old fast. That's where the FlipLink API comes in — it lets you programmatically create flipbooks, manage publications, pull analytics, and wire FlipLink into your existing tools and workflows.

Whether you're a developer building a custom integration or a team lead looking to automate repetitive tasks, this guide walks you through what the API can do and how to get started.

What the FlipLink API Lets You Do

The FlipLink REST API gives you programmatic access to the same capabilities available in the dashboard. Instead of clicking through the UI, you send HTTP requests and get structured JSON responses back.

Here's what you can accomplish:

• Create flipbooks and documents from PDF files (upload or URL) without opening the dashboard
• Update publication settings like metadata, lead capture forms, skins, and access controls
• Pull engagement data — view counts per flipbook, plus full lead and sale exports
• Manage publications at scale — create, update, or delete dozens of flipbooks in a single script
• Trigger workflows with per-flipbook webhooks that fire when a new lead is captured

For a full overview of programmatic features, check out the API Access feature page — and for the exact endpoints, parameters, and live examples, the API reference.

Getting Your API Key

Before making any API calls, you need an API key. Here's how to grab one:

1. Log in to your FlipLink dashboard at go.fliplink.me
2. Navigate to Settings → API Access
3. Click Generate API Key
4. Copy the key and store it securely — treat it like a password

Your API key authenticates every request. Pass it in the X-Api-Key header:

X-Api-Key: YOUR_API_KEY

Important: Never expose your API key in client-side code or public repositories. Keep it server-side or in environment variables. The Authentication section of the API reference covers this in full.

Common API Use Cases

Bulk Flipbook Creation

Got a folder of 50 product catalogs that need to become flipbooks? Instead of uploading them one by one, write a script that loops through your PDFs and hits the creation endpoint for each. Pair this with Bulk Operations for maximum efficiency.

Pulling Analytics Into Your Own Dashboard

If you track marketing performance in a centralized tool — a custom dashboard, Google Sheets, or a BI platform — you can pull FlipLink view and engagement data via the API and consolidate it alongside your other metrics.

Publication Management at Scale

Need to update the branding on all your flipbooks after a rebrand? Or archive last quarter's catalogs? The API lets you batch those updates without clicking through each publication individually.

Connecting to Automation Platforms

Combine the API with tools like Zapier, Pabbly, or Make to build no-code workflows. For example, automatically create a flipbook whenever a new PDF lands in a specific Google Drive folder. See our guide on connecting FlipLink to automation platforms for step-by-step instructions, or explore the Automation and Integrations feature.

Try FlipLink Free

Convert your PDF in seconds. No sign-up, no credit card — just upload and go.

Drop your PDF here or click to browse

Max 40MB

Paid plans from $39 raise this to 150 MB.

Example: Creating a Flipbook via API

Here's a basic example using curl to create a new flipbook from a PDF upload:

curl -X POST 'https://go.fliplink.me/api/create-by-file' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@product-catalog.pdf' \
  -F 'Name=Spring Product Catalog' \
  -F 'Title=Spring Product Catalog' \
  -F 'DocType=Flipbook'

The API returns a JSON response — {"Result":"OK","ID":"90001","URL":"https://go.fliplink.me/view/<slug>", ...} — with the publication ID and share URL you need to distribute the flipbook immediately. Already have the PDF online? Swap in POST /api/create-by-url and pass FileURL instead of File.

You can do the same in Python, Node.js, or any language that speaks HTTP. The API is standard REST with form-urlencoded (or multipart) bodies, so it works with whatever stack you're already using. One thing to remember: application errors come back as HTTP 200 with Result: "ERROR" (only auth failures return 401), so branch on the Result field.

Available API Endpoints

This is a small slice — the full catalog of 80+ endpoints, each with parameters and a live Try-It console, lives in the API reference.

All endpoints return JSON. The rate limit is 300 requests per minute per API key. See the API reference for every endpoint, its parameters, the error model, and dependency paths.

When to Use the API vs. the Dashboard

Not everything needs an API call. Here's a simple decision framework:

• Use the dashboard when you're creating a single flipbook, tweaking design settings visually, or exploring analytics casually
• Use the API when you're handling more than five publications at once, integrating with other systems, or automating recurring tasks
• Use automation platforms (Zapier/Make/Pabbly) when you want API-level power without writing code

For teams managing product catalogs or any content that updates regularly, the API pays for itself in time saved after the first batch run.

Start Building

The FlipLink API turns manual busywork into automated workflows. Whether you're syncing analytics to a dashboard, bulk-creating flipbooks from a content pipeline, or wiring FlipLink into your CRM — the API gives you the control to build exactly what you need.

Ready to get started? Create your free FlipLink account, generate your API key, and open the API reference to try every endpoint live in your browser. Check out our pricing to see what's included with API access.