You have to provide an api key on every conversion request. Both the manually and API converted flipbooks will show up in your dashboard.
Login or register to view your api key here.
You can convert a PDF with a simple link or you can use our jQuery plugin to automatically convert all the PDF links of a page.
Define a link with parameters pointing to your pdf file for dynamic conversion and use it in anchors, iframes, dialogs or anywhere else.
Base url: https://heyzine.com/api1/
Url parameters:
| Parameter | Required | Description |
|---|---|---|
| required | Url pointing to the pdf to be converted | |
| k | required | Api key for the conversion, you can get the key for free above |
| t | optional | Title shown in the pdf page |
| s | optional | Subtitle shown in the pdf page |
| d | optional | Allow downloading the original pdf |
| fs | optional | Show the fullscreen button. fs=1 to show it. |
| pn | optional | Show the previous and next buttons. pn=1 to show it. |
| st | optional | Show the title, subtitle and description on the flipbook's background. st=1 to show it. |
| bg | optional | Remove the background image and use a solid hex color. bg=00000 for black bg=ffffff for white background |
| lg | optional | Url pointing to the company logo you want to place in the flipbook |
The link will redirect to the final flipbook url. If you want to make the conversion server-side to avoid revealing the original url, you can use the /rest path and it will return a json.
Examples
https://heyzine.com/api1?pdf=http://www.pdf995.com/samples/pdf.pdf&k=d3m0
https://heyzine.com/api1?pdf=http://www.pdf995.com/samples/pdf.pdf&t=Test title&s=Test subtitle&d=1&k=d3m0
Examples json
https://heyzine.com/api1/rest?pdf=http://www.pdf995.com/samples/pdf.pdf&k=d3m0
https://heyzine.com/api1/rest?pdf=http://www.pdf995.com/samples/pdf.pdf&t=Test title&s=Test subtitle&d=1&k=d3m0
jQuery plugin to convert all the PDF links on your site to a flipbook magazine.
Usage steps:
1.-Include jquery and the plugin through a CDN or download and include them in your project:
<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://cdn.heyzine.com/release/jquery.pdfflipbook.3.js"></script>
2.-Call the plugin with the key to convert all the links:
$('a').pdfFlipbook({ key: 'd3m0' });
3.-Optionally, you can use DOM attributes to customize the resulting flipbook and presentation:
| Parameter | Required | Description | Example |
|---|---|---|---|
| flipbook | Optional | When the element has an href, this attribute will be ignored, otherwise defines the url of the pdf file and binds a click event for navigation. | <span flipbook="/link-to-pdf.pdf">This is a flipbook</span> |
| title | Optional | Title for the page | <a flipbook="/link-to-pdf.pdf" title="title">This is a flipbook</a> |
| subtitle | Optional | Subtitle for the page | <a flipbook="/link-to-pdf.pdf" subtitle="subtitle">This is a flipbook</a> |
| showdownload | Optional | Show the download button on the flipbook page | <a flipbook="/link-to-pdf.pdf" showdownload>This is a flipbook</a> |
| showmodal | Optional | Opens the flipbook in a simple modal over the page | <a flipbook="/link-to-pdf.pdf" showmodal>This is a flipbook</a> |
Check a simple jquery demo here: Demo
With the free plan, you have up to 5 free flipbooks, after that the oldest will be removed.
You can add additional flipbooks by buying flipbook packs.
With the standard and professional plans you have unlimited conversions.
