Getting Started with Flipsnack API (Application Programming Interface)

Learn the basics of our API to start automating workflows and integrating our platform with your own

Table of contents

• Overview
• Industry-specific API use cases
  • Automated brochures & presentations
  • Smooth magazine publishing
  • Centralized management for agencies
  • Online product catalog PDFs
  • Employee handbooks & training materials
  • Real estate listings
  • Educational course materials
  • Nonprofit reports & collateral
• How to get started
  1. Apply for an API Key
  2. Choose an API Method
  3. Make a Request
  4. Parse the Response
  5. Handle Errors
• API Status Codes
• API Limitations
• Next steps

Overview

The Flipsnack API (Application Programming Interface) allows businesses to integrate Flipsnack into their workflows by enabling you to automate tasks such as creating flipbooks via PDFs or image upload, configuring flipbook settings (visibility, menu controls, flipbook size, and background), retrieving analytics, and embedding flipbooks. The API is designed to streamline processes, improve efficiency, and enhance digital publishing experiences.

Here is a short list of what you can do with our API:

• Upload a file (PDF / JPG / PNG) to create a new flipbook
• Update flipbook settings 
• Delete flipbooks
• Retrieve data from about a flipbook
• Get a list of flipbooks from a user or a folder
• Access statistics for workspaces or individual flipbook
• Get embed codes for flipbooks
• Generate and download HTML packages

Requirements

• Plan: API access is available on demand as part of the Enterprise plan.
• Target audience: IT teams, developers, marketing automation specialists, and businesses looking for deeper integrations.

Industry-specific API use cases

The Flipsnack API empowers businesses across a wide range of industries to automate content workflows and streamline processes:

Automated brochures & presentations

A multinational consulting firm wanted a quick way to share proposals and pitch decks internally. By automating the PDF-to-flipbook process with Flipsnack’s API, they eliminated manual uploads and instantly matched each flipbook to their brand identity.

Why use it:

Instantly convert your PDF brochures or presentations into branded, interactive flipbooks. Automate the process—no manual uploads are needed—and easily adjust design settings (e.g., width, background color).

Key methods:

• collection.create for uploading PDFs and creating new flipbooks.

Smooth magazine publishing

A magazine publisher uploads large volumes of magazines as soon as the PDF files are ready. They then apply collection.update to enable auto-flip, creating an engaging reading experience, and use collection.downloadHTML to offer offline versions to subscribers.

Why use it:

Rapidly publish new issues the moment they’re ready, give readers multiple viewing options, and seamlessly remove outdated editions.

Key methods:

• collection.update to enable auto-flip, set right-to-left orientation, or tweak settings.
• collection.downloadHTML to generate offline versions.

Centralized management for agencies

A digital marketing agency manages flipbooks for multiple clients, each with its branding. By calling collection.getList, they see which flipbooks belong to which client. Then, with collection.update, they apply new logos or color schemes in bulk and track performance across all accounts using user.getStats.

Why use it:
Handle numerous flipbooks from a single dashboard, update themes or permissions all at once, and analyze overall performance with user statistics.

Key methods:

• collection.getList to retrieve all your flipbooks.
• collection.update to apply bulk changes.
• user.getStats for an overview of your account.

Online product catalog PDFs

An eCommerce retailer with seasonal collections uploads product catalogs via collection.create. They track which items get the most views using collection.getStats and adjust inventory and marketing efforts accordingly.

Why use it:
Showcase product catalogs as interactive flipbooks, control who can view them (public vs. unlisted), and funnel inquiries directly into your CRM.

Key methods:

• collection.create for generating flipbooks from PDFs.
• collection.getStats for detailed statistics.

Employee handbooks & training materials

A global tech company creates flipbooks for HR policies and training guides via collection.create. They limit access to employees only using collection.update and remove outdated content with collection.deleteCollection.

Why use it:
Give your team easy access to internal manuals and training content. Restrict access for confidentiality and track engagement (views, time spent) to optimize training.

Key methods:

• collection.create to upload internal documents.
• collection.update to control settings like download permissions.
• collection.deleteCollection to remove outdated files.

Real estate listings

A real estate agency automates the creation of new flipbooks for property listings using collection.create, embeds each one on their site via collection.getEmbed, and promptly deletes sold properties with collection.deleteCollection.

Why use it:
Offer virtual, interactive property brochures and ensure your listing portfolio is always accurate by adding or removing flipbooks as properties become available or sell.

Key methods:

• collection.create to convert property brochures into flipbooks.
• collection.getEmbed to retrieve the embed code for your listings.
• collection.deleteCollection to remove sold properties.

Educational course materials

An online education provider reviews all course materials before the semester using collection.getCollection. They replace outdated PDFs using collection.update, and analyze where students spend the most time with collection.getStats.

Why use it:
Provide students with a secure, trackable format for syllabi and lesson plans. Gain page-level insights to identify topics that may need more attention or revision.

Key methods:

• collection.getCollection to retrieve flipbook details.
• collection.update to revise or replace content.
• collection.getStats for page-level insights.

Nonprofit reports & collateral

A nonprofit creates annual reports as flipbooks and uses collection.downloadHTML to generate offline versions for field offices with limited connectivity. They verify privacy and interactivity settings with collection.getCollection to ensure sensitive donor data remains secure.

Why use it:
Present donor updates, annual reports, or event recaps as polished flipbooks. Adjust privacy levels and embed sign-up forms or donation links for better engagement.

Key methods:

• collection.downloadHTML to offer offline or self-hosted versions.
• collection.getCollection to review existing settings.

By leveraging Flipsnack’s API you can automate a range of publishing workflows. Whether you’re a magazine publisher, a real estate agency, or an educational institution, Flipsnack offers flexibility and control for seamless, branded flipbook creation and management.

How to get started

1. Apply for an API Key

• Log in to your Flipsnack account.
• Navigate to Settings > API tab.
• Click Get API Key to generate an API key and secret key.
• Keep your API key and secret key confidential. If compromised, reset them immediately.

2. Choose an API Method

Flipsnack API has two primary endpoints:

• Uploads: https://upload.flipsnack.com/v1
• General Requests: https://api.flipsnack.com/v1

Determine which API method fits your needs:

API Method	Purpose
collection.create	Upload a new PDF to create a flipbook.
collection.getCollection	Retrieves details about a flipbook.
collection.update	Updates flipbook settings.
collection.deleteCollection	Deletes a flipbook.
collection.getEmbed	Retrieves embed codes.
collection.getStats	Retrieves statistics on engagement.
collection.getList	Returns a list of flipbooks belonging to your user.
collection.downloadHTML	Starts generating the download package and returns the progress status. When the status is complete it also returns the resource url.
user.getStats	Returns global statistics for your user.
zapier.getZapierLeadFormSample	Returns information about leadform. The information contains sample data about your fields that might be used for integration.

3. Make a Request

Every API request must include the following parameters:

• apiKey – For authentication.
• signature – A security hash.
• action – The specific API method being executed.

Example request:

curl -X GET "https://api.flipsnack.com/v1/" \  
-G \  
-d action=collection.getCollection \  
-d apiKey=<YOUR-API-KEY> \  
-d collectionHash=<COLLECTION-HASH> \  
-d signature=<YOUR-REQUEST-SIGNATURE>

4. Parse the Response

Responses are returned in JSON format and contain:

• code – Status code.
• status – Message indicating success or failure.
• data – The requested information (if applicable).

5. Handle Errors

Error responses include a status code and an error message. Review the status codes below to diagnose issues.

API Status Codes

Here are the key API status codes:

For a full list, visit the Flipsnack API Status Codes page.

API Limitations

Limitation	Details
Uploads per month	Max 1000 uploads.
Accepted file formats	PDF, JPG.
Max file size	500MB per PDF, 1000 pages per flipbook.
Rate limits	31 requests per second, 60 requests per minute.

If limits are exceeded, an error response will be returned. 

Next steps

Explore detailed API documentation

For developers needing in-depth technical details, you can visit the Flipsnack API Documentation.

Need expert support?

Our team is here to help. Connect with our team experts or message us via the in-app chat for a personalized demo.