Heyzine API
Application programming interface for developers or NoCode tools to integrate flipbooks in applications or workflows.
Empezando
Heyzine provides a comprehensive and flexible API to manage flipbooks in your account. It allows you to create, list and delete flipbooks, manage the access list with password, get embed codes and receive leads via webhooks. The API uses either a Client ID or an API key for authentication. When the API Key is required, you must provide it in a header this way:
Authorization: Bearer API_KEY
PDF to Flipbook Conversion
Link Conversion
Create a link with parameters pointing to your pdf file and use it in anchors, iframes, dialogs, or anywhere else. The link will redirect to the final flipbook url. The conversion process starts with the first access, so it can take some time to load the first time you open it. To convert server-side and avoid revealing the original url, you can use the /rest endpoint and get a json response.
Link format
https://heyzine.com/api1?pdf={pdf url}&k={client id}
Basic example
https://heyzine.com/api1?pdf=https://codingfocus.com/sample.pdf&k=d3m0
Titles and controls
https://heyzine.com/api1?pdf=https%3A%2F%2Fcodingfocus.com%2Fsample.pdf%3Fexample2&t=Test%20title&s=Test%20subtitle&d=1&k=d3m0
Copy design from template
https://heyzine.com/api1?pdf=https%3A%2F%2Fcodingfocus.com%2Fsample.pdf%3Fexample3&k=d3m0&tpl=02d4d12c08593f3d10a5f61338758eaa0bf67abd.pdf
REST API Conversion
Call the Sync REST endpoint client or server-side, to convert the PDF and get a JSON response with the links to the flipbook, thumbnail, and PDF. The endpoint will send the response right after the conversion ends. You have to make sure the client has a long enough time out for the largest documents.
Call the Async REST endpoint to get the JSON response immediately in case you don't want to wait for the conversion process. Subsequent calls to the endpoint with the same parameters will return the current state of the conversion. (started, processed, or failed). During the conversion time, flipbook links will show a not-found page.
Sync Endpoint
POST https://heyzine.com/api1/rest
Request example
{
"pdf": "https://codingfocus.com/sample.pdf",
"client_id": "d3m0",
"prev_next": true
}
Response example
{
"id": "e8264ee61f7f5a9fd4291590480762b998574610.pdf",
"url": "https://heyzine.com/flip-book/e8264ee61f.html",
"thumbnail": "https://cdnc.heyzine.com/flip-book/cover/e8264ee61f.jpg",
"pdf": "https://cdnc.heyzine.com/flip-book/pdf/e8264ee61f7f5a9fd4291590480762b998574610.pdf",
"meta": {
"num_pages": 6,
"aspect_ratio": 0.7078
}
}
Async Endpoint
POST https://heyzine.com/api1/async
Request example
{
"pdf": "https://codingfocus.com/sample.pdf",
"client_id": "d3m0",
"show_info": true,
"background_color": "ffffff"
}
Response example
{
"id": "e8264ee61f7f5a9fd4291590480762b998574610.pdf",
"url": "https://heyzine.com/flip-book/e8264ee61f.html",
"thumbnail": "https://cdnc.heyzine.com/flip-book/cover/e8264ee61f.jpg",
"pdf": "https://cdnc.heyzine.com/flip-book/pdf/e8264ee61f7f5a9fd4291590480762b998574610.pdf",
"meta": {
"num_pages": 6,
"aspect_ratio": 0.7078
},
"state": "processed"
}
Flipbook Management
Get flipbook info
Get all available information about a specific flipbook by its identifier.
Endpoint
GET https://heyzine.com/api1/flipbook-details
Authorization: Bearer API_KEY
Request example
{
"id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf"
}
Response example
{
"id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf",
"date": "2024-11-05T13:58:48Z",
"title": "My awesome test",
"subtitle": "Flipbook conversion using the API",
"description": "The description of the flipbook",
"private": "Internal management note",
"pages": 67,
"tags": "catalogs,summer,promotions",
"links": {
"custom": "https://mycustomdomain.aflip.in/my-flipbook",
"base": "https://heyzine.com/flip-book/c16430e4c0.html",
"thumbnail": "https://cdnc.heyzine.com/flip-book/cover/c16430e4c0.jpg",
"pdf": "https://cdnc.heyzine.com/flip-book/pdf/c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf"
},
"oembed": { oEmbed object},
}
List flipbooks
Get a list of all the flipbooks in the account.
Endpoint
GET https://heyzine.com/api1/flipbook-list
Authorization: Bearer API_KEY
Response example
[
{
"id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf",
"date": "2024-11-05T13:58:48Z",
"title": "My awesome test",
"subtitle": "Flipbook conversion using the API",
"description": "The description of the flipbook",
"private": "Internal management note",
"pages": 67,
"size": 143135,
"links": {
"custom": "https://mycustomdomain.aflip.in/my-flipbook",
"base": "https://heyzine.com/flip-book/c16430e4c0.html",
"thumbnail": "https://cdnc.heyzine.com/flip-book/cover/c16430e4c0.jpg",
"pdf": "https://cdnc.heyzine.com/flip-book/pdf/c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf"
}
}
]
Delete flipbook
Delete an specific flipbook by its identifier.
Endpoint
POST https://heyzine.com/api1/flipbook-delete
Authorization: Bearer API_KEY
Request example
{
"id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf"
}
Response example
{
"success": true,
"code": 200,
"msg": "Flipbook deleted"
}
Password Protection
Configure the password protection
Configure the password-protection mode, and the text that will be used to ask for the user name and password on the flipbook´s login page.
Endpoint
POST https://heyzine.com/api1/access-setup
Authorization: Bearer API_KEY
Request example
{
"name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
"mode": "users",
"text_user": "Please, type your email:",
"text_password": "Please, type your password:"
}
Response example
{
"success": true,
"code": 200,
"msg": "Access configuration set"
}
Add user access
Grant user access to a flipbook.
email_link and send_code are only available on Premium Plans
Endpoint
POST https://heyzine.com/api1/access-add
Authorization: Bearer API_KEY
Request example
{
"name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
"access_type": "user_pass",
"user": "reader@heyzine.com",
"password": "mYp4ssW0rd"
}
Response example
{
"success": true,
"code": 200,
"msg": "Added to the access list"
}
Remove user access
Revoke user access to a flipbook.
Endpoint
POST https://heyzine.com/api1/access-remove
Authorization: Bearer API_KEY
Request example
{
"name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
"user": "reader@heyzine.com",
}
Response example
{
"success": true,
"code": 200,
"msg": "Removed from the access list"
}
Find the ID of a flipbook on your account
jQuery PDF a flipbook
jQuery plugin to convert all the PDF links on your site to flipbooks.
Pasos de uso:
1.-Incluye jquery y el plugin mediante un CDN o descarga e incluyelo en tu proyecto:
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script type="text/javascript" src="https://cdnc.heyzine.com/release/jquery.pdfflipbook.4.js"></script>
2.-Call the plugin with the Client Id to convert all the links:
$('a').pdfFlipbook({ key: 'd3m0' });
3.-Opcionalmente, puedes usar atributos DOM para personalizar el resultado del flipbook y la presentación:
| Parámetro | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|
| flipbook | Opcional | Cuando el elemento tiene href, este atributo se ignora, en caso contrario define la url del archivo pdf y asocia un evento de clic para navegación. | <span flipbook="/link-to-pdf.pdf">Esto es un flipbook</span> |
| title | Opcional | Título para la página | <a flipbook="/link-to-pdf.pdf" title="title">Esto es un flipbook</a> |
| subtitle | Opcional | Subtítulo para la página | <a flipbook="/link-to-pdf.pdf" subtitle="subtitle">Esto es un flipbook</a> |
| showdownload | Opcional | Muestra el botón de descarga en la página del flipbook | <a flipbook="/link-to-pdf.pdf" showdownload>Esto es un flipbook</a> |
| showmodal | Opcional | Abre el flipbook en un diálogo sencillo encima de la página | <a flipbook="/link-to-pdf.pdf" showmodal>Esto es un flipbook</a> |
See the jquery demo here: Demo
oEmbed API
oEmbed is an API that allows third-party websites and apps to fetch an Html embed code to display Heyzine flipbooks.
Discovering oEmbed URIs
Most flipbooks support oEmbed. Your application can discover the corresponding oEmbed URI by searching the flipbook for a element with the type "application/json+oembed".
For example, the flipbook sample here, includes the following link tag:
<link rel="alternate" type="application/json+oembed" href="https://heyzine.com/api1/oembed?url=https%3A%2F%2Fheyzine.com%2Fflip-book%2Fdce36e099f.html&format=json" title="PDF to Flipbook | Heyzine" />
Using oEmbed data from Heyzine in your app or website
Send a GET request to /api1/oembed, with the url parameter set to a flipbook link to get his oEmbed data.
Heyzine supports the standard oEmbed 1.0 parameters (url, format, maxwidth, and maxheight).
Request
https://heyzine.com/api1/oembed?url=https%3A%2F%2Fheyzine.com%2Fflip-book%2Fdce36e099f.html&format=json
Response
{
"type": "rich",
"version": "1.0",
"title": "Venice guide",
"provider_name": "Heyzine",
"provider_url": "https:\/\/heyzine.com",
"html": "<iframe allowfullscreen=\"allowfullscreen\" allow=\"clipboard-write\" scrolling=\"no\" class=\"fp-iframe\" style=\"width: 100%; height: 600px;\" src=\"https:\/\/heyzine.com\/flip-book\/dce36e099f.html\"><\/iframe>",
"width": 1920,
"height": 2717,
"thumbnail_url": "https:\/\/heyzine.com\/files\/uploaded\/v2\/dce36e099f71f95449f722bfc227cb4bdd1b30f0.pdf-thumb.jpg",
"thumbnail_width": 400,
"thumbnail_height": 566
}
Webhooks
Heyzine supports webhooks to notify events to an external endpoint URL with a predefined frequency.
Access your account webhooks section to define the endpoints and frequency.
Leads Webhook
The webhook will be called each time new leads are collected on any lead generation form in the account.
Request body reference:
data: {
"id_webhook": Identifier of the event,
"date": Date an time (UTC) of the event request,
"leads": [
0: {
date: Date and time (UTC) when the lead was collected,
first_value: Answer to the first field on the form,
second_value: Answer to the second field on the form,
flipbook: {
id: Identifier of the flipbook containing the form,
title: Title set on the publish settings of the flipbook
},
answer: [
0: {
label: Question on the form,
value: Lead answer,
},...
]
},...
]
}
Límites API
With the free plan, you have up to 5 free flipbooks, after the limit the oldest publications will be removed. With a subscription you have unlimited conversions. We assume fair use of the api. Please contact us for information on special use cases.
Social Metadata
Set social metadata for a flipbook
Set the title, description, and thumbnail for the social sharing metadata of a specific flipbook.
Endpoint
POST https://heyzine.com/api1/flipbook-social
Authorization: Bearer API_KEY
Request example
{
"id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf",
"title": "My Flipbook Title",
"description": "A description for social sharing.",
"thumbnail": "https://example.com/image.jpg"
}
Response example
{
"success": true
}
Set social metadata for a bookshelf
Set the title, description, and thumbnail for the social sharing metadata of a specific bookshelf (library).
Endpoint
POST https://heyzine.com/api1/bookshelf-social
Authorization: Bearer API_KEY
Request example
{
"id": "library1234567890abcdef",
"title": "My Bookshelf Title",
"description": "A description for social sharing.",
"thumbnail": "https://example.com/library-image.jpg"
}
Response example
{
"success": true
}