Heyzine API

https://heyzine.com/developers
Admin
Heyzine API is an application programming interface that allows developers to convert PDFs, DOCX,...
Tokens:9,081
Snippets:37
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Async REST API

Source: https://heyzine.com/developers/index

Initiates the conversion of a PDF, DOCX, or PPTX file into a flipbook asynchronously. Returns immediately with the current conversion state. Subsequent calls with the same parameters retrieve the updated state (started, processed, or failed).

```APIDOC
## POST /api1/async

### Description
Initiates the conversion of a PDF, DOCX, or PPTX file into a flipbook asynchronously. Returns immediately with the current conversion state. Subsequent calls with the same parameters retrieve the updated state (started, processed, or failed).

### Method
POST

### Endpoint
https://heyzine.com/api1/async

### Parameters
#### Request Body
- **pdf** (string) - Required - URL pointing to the pdf, docx or pptx to be converted. Must be a direct link with no redirections and correctly url-encoded.
- **client_id** (string) - Required - Client ID. Get the client id.
- **template** (string) - Optional - Flipbook ID to use as a template. It copies the logo, page effect, background, controls, and all the styles. It doesn't copy the access list and interactions.
- **title** (string) - Optional - Title shown on the flipbook and social shares.
- **subtitle** (string) - Optional - Subtitle to show on the flipbook and social shares.
- **description** (string) - Optional - Description to show on the flipbook and social shares.
- **private_note** (string) - Optional - Internal text that is never shown to visitors. Corresponds to the “private” parameter of the flipbook response object.
- **tags** (string) - Optional - Comma-separated list of tags to organize and filter the flipbook in the administration panel. Example: "catalog,summer,last collection"
- **download** (boolean) - Optional - Allow downloading the original pdf. true to allow it.
- **full_screen** (boolean) - Optional - Show the fullscreen button. true to show it.
- **share** (boolean) - Optional - Show the share button. true to show it.
- **prev_next** (boolean) - Optional - Show the previous and next buttons. true to show it.
- **show_info** (boolean) - Optional - Show the title, subtitle and description on the flipbook's background. true to show it.
- **background_color** (string) - Optional - Remove the background image and use a solid hex color. Example: "00000" for black, "ffffff" for white.
- **logo** (string) - Optional - URL pointing to the company logo you want to place in the flipbook. Available on the Standard Plan and above.

### Request Example
```json
{
  "pdf": "https://codingfocus.com/sample.pdf",
  "client_id": "d3m0",
  "show_info": true,
  "background_color": "ffffff"
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the converted flipbook.
- **url** (string) - URL to the flipbook.
- **thumbnail** (string) - URL to the flipbook's thumbnail.
- **pdf** (string) - URL to the original converted PDF.
- **meta** (object) - Metadata about the flipbook.
  - **num_pages** (integer) - The number of pages in the flipbook.
  - **aspect_ratio** (float) - The aspect ratio of the flipbook pages.
- **state** (string) - The current state of the conversion process (e.g., "started", "processed", "failed").

#### Response Example
```json
{
  "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"
}
```
```

--------------------------------

### Get Flipbook Details (REST API)

Source: https://heyzine.com/developers/index

Retrieves comprehensive information for a specific flipbook using its identifier. Requires an API key for authorization.

```json
{
  "id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf"
}
```

--------------------------------

### Link Conversion API

Source: https://heyzine.com/developers/index

Convert PDF, DOCX, or PPTX files into flipbooks using a direct link with various parameters for customization. The conversion starts on first access.

```APIDOC
## POST /api1 (Link Conversion)

### Description
Creates a link to convert a PDF, DOCX, or PPTX file into a flipbook. The conversion is initiated upon the first access of the link. For server-side conversion and JSON responses, use the `/rest` endpoint.

### Method
GET

### Endpoint
https://heyzine.com/api1

### Parameters
#### Query Parameters
- **pdf** (string) - Required - URL pointing to the PDF, DOCX, or PPTX file. Must be a direct link without redirections and properly URL-encoded.
- **k** (string) - Required - Client ID for authentication.
- **tpl** (string) - Optional - Flipbook ID to use as a template for styles (logo, page effect, background, controls). Does not copy access lists or interactions.
- **t** (string) - Optional - Title to display on the flipbook and social shares.
- **s** (string) - Optional - Subtitle to display on the flipbook and social shares.
- **d** (boolean) - Optional - Allow downloading the original PDF (1 for allow, 0 for disallow).
- **fs** (boolean) - Optional - Show the fullscreen button (1 for show, 0 for hide).
- **sh** (boolean) - Optional - Show the share button (1 for show, 0 for hide).
- **pn** (boolean) - Optional - Show the previous and next buttons (1 for show, 0 for hide).
- **st** (boolean) - Optional - Show the title, subtitle, and description on the flipbook's background (1 for show, 0 for hide).
- **bg** (string) - Optional - Set a solid background color using a hex code (e.g., '000000' for black, 'ffffff' for white). Removes the background image.
- **lg** (string) - Optional - URL pointing to the company logo to be placed in the flipbook. Available on Standard Plan and above.

### Request Example
```
https://heyzine.com/api1?pdf=https://codingfocus.com/sample.pdf&k=d3m0
```

### Response
This endpoint returns a redirect to the flipbook URL. For a JSON response with conversion status, use the `/rest` endpoint.

#### Success Response (302 Found)
- **Location** (string) - The URL of the created flipbook.

#### Response Example
```
https://your-flipbook-url.heyzine.com/...
```
```

--------------------------------

### Get Flipbook Info API

Source: https://heyzine.com/developers/index

Retrieves all available information about a specific flipbook using its unique identifier. Includes details like title, description, pages, tags, and various links.

```APIDOC
## GET /api1/flipbook-details

### Description
Retrieves all available information about a specific flipbook using its unique identifier. Includes details like title, description, pages, tags, and various links.

### Method
GET

### Endpoint
https://heyzine.com/api1/flipbook-details

### Parameters
#### Query Parameters
- **id** (string) - Required - Flipbook Identifier

#### Headers
- **Authorization** (string) - Required - Bearer API_KEY

### Request Example
```json
{
  "id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf"
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the flipbook.
- **date** (string) - Date and time the flipbook was created or last updated.
- **title** (string) - Title of the flipbook.
- **subtitle** (string) - Subtitle of the flipbook.
- **description** (string) - Description of the flipbook.
- **private** (string) - Internal management note for the flipbook.
- **pages** (integer) - Number of pages in the flipbook.
- **tags** (string) - Comma-separated list of tags associated with the flipbook.
- **links** (object) - Object containing various URLs related to the flipbook.
  - **custom** (string) - Custom domain URL for the flipbook.
  - **base** (string) - Base URL for the flipbook.
  - **thumbnail** (string) - URL for the flipbook's thumbnail.
  - **pdf** (string) - URL for the flipbook's PDF.
- **oembed** (object) - oEmbed object containing embeddable information for the flipbook.

#### Response Example
```json
{
  "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"}
}
```
```

--------------------------------

### Async PDF to Flipbook Conversion (REST API)

Source: https://heyzine.com/developers/index

Initiates a PDF to flipbook conversion and returns a JSON response immediately. Subsequent calls with the same parameters provide the conversion state. Flipbook links are unavailable during conversion.

```json
{
  "pdf": "https://codingfocus.com/sample.pdf",
  "client_id": "d3m0",
  "show_info": true,
  "background_color": "ffffff"
}
```

--------------------------------

### Sync PDF to Flipbook Conversion (REST API)

Source: https://heyzine.com/developers/index

Converts a PDF to a flipbook and returns a JSON response with links to the flipbook, thumbnail, and original PDF. Client timeouts should be sufficient for large documents.

```json
{
  "pdf": "https://codingfocus.com/sample.pdf",
  "client_id": "d3m0",
  "prev_next": true
}
```

--------------------------------

### Sync REST API

Source: https://heyzine.com/developers/index

Converts a PDF, DOCX, or PPTX file into a flipbook synchronously. The response contains direct links to the flipbook, thumbnail, and original PDF upon completion.

```APIDOC
## POST /api1/rest

### Description
Converts a PDF, DOCX, or PPTX file into a flipbook synchronously. The response contains direct links to the flipbook, thumbnail, and original PDF upon completion.

### Method
POST

### Endpoint
https://heyzine.com/api1/rest

### Parameters
#### Request Body
- **pdf** (string) - Required - URL pointing to the pdf, docx or pptx to be converted. Must be a direct link with no redirections and correctly url-encoded.
- **client_id** (string) - Required - Client ID. Get the client id.
- **template** (string) - Optional - Flipbook ID to use as a template. It copies the logo, page effect, background, controls, and all the styles. It doesn't copy the access list and interactions.
- **title** (string) - Optional - Title shown on the flipbook and social shares.
- **subtitle** (string) - Optional - Subtitle to show on the flipbook and social shares.
- **description** (string) - Optional - Description to show on the flipbook and social shares.
- **private_note** (string) - Optional - Internal text that is never shown to visitors. Corresponds to the “private” parameter of the flipbook response object.
- **tags** (string) - Optional - Comma-separated list of tags to organize and filter the flipbook in the administration panel. Example: "catalog,summer,last collection"
- **download** (boolean) - Optional - Allow downloading the original pdf. true to allow it.
- **full_screen** (boolean) - Optional - Show the fullscreen button. true to show it.
- **share** (boolean) - Optional - Show the share button. true to show it.
- **prev_next** (boolean) - Optional - Show the previous and next buttons. true to show it.
- **show_info** (boolean) - Optional - Show the title, subtitle and description on the flipbook's background. true to show it.
- **background_color** (string) - Optional - Remove the background image and use a solid hex color. Example: "00000" for black, "ffffff" for white.
- **logo** (string) - Optional - URL pointing to the company logo you want to place in the flipbook. Available on the Standard Plan and above.

### Request Example
```json
{
  "pdf": "https://codingfocus.com/sample.pdf",
  "client_id": "d3m0",
  "prev_next": true
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the converted flipbook.
- **url** (string) - URL to the flipbook.
- **thumbnail** (string) - URL to the flipbook's thumbnail.
- **pdf** (string) - URL to the original converted PDF.
- **meta** (object) - Metadata about the flipbook.
  - **num_pages** (integer) - The number of pages in the flipbook.
  - **aspect_ratio** (float) - The aspect ratio of the flipbook pages.

#### Response Example
```json
{
  "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
  }
}
```
```

--------------------------------

### Configure Password Protection

Source: https://heyzine.com/developers/index

Sets up password protection for a flipbook, defining the access mode and related text prompts.

```APIDOC
## Password Protection

### Configure the Password Protection

### Description
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.

### Method
POST

### Endpoint
https://heyzine.com/api1/access-setup

### Authorization
Bearer API_KEY

### Parameters
#### Request Body
- **name** (string) - Required - Flipbook Identifier
- **mode** (string) - Required - Access mode: "users", "everyone", or "disabled"
- **text_user** (string) - Text used to ask for the username on the login screen.
- **text_password** (string) - Text used to ask for the password on the login screen.
- **password** (string) - Required when mode is "everyone". Password to be used on the flipbook login page.

### Request Example
```json
{
  "name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
  "mode": "users",
  "text_user": "Please, type your email:",
  "text_password": "Please, type your password:"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the configuration was set successfully.
- **code** (integer) - The HTTP status code.
- **msg** (string) - A message confirming the setup.

#### Response Example
```json
{
  "success": true,
  "code": 200,
  "msg": "Access configuration set"
}
```
```

--------------------------------

### oEmbed API

Source: https://heyzine.com/developers/index

Fetch HTML embed code to display Heyzine flipbooks on third-party websites and apps. Supports standard oEmbed parameters.

```APIDOC
## GET /api1/oembed

### Description
Fetch an HTML embed code to display Heyzine flipbooks on external platforms using the oEmbed standard.

### Method
GET

### Endpoint
https://heyzine.com/api1/oembed

### Query Parameters
- **url** (string) - Required - The URL of the Heyzine flipbook.
- **format** (string) - Optional - The desired output format (e.g., 'json'). Defaults to 'json'.
- **maxwidth** (integer) - Optional - The maximum width of the embedded flipbook.
- **maxheight** (integer) - Optional - The maximum height of the embedded flipbook.

### Request Example
```
https://heyzine.com/api1/oembed?url=https%3A%2F%2Fheyzine.com%2Fflip-book%2Fdce36e099f.html&format=json
```

### Response
#### Success Response (200)
- **type** (string) - The type of oEmbed resource (e.g., 'rich').
- **version** (string) - The oEmbed protocol version.
- **title** (string) - The title of the flipbook.
- **provider_name** (string) - The name of the provider (Heyzine).
- **provider_url** (string) - The URL of the provider.
- **html** (string) - The HTML embed code for the flipbook.
- **width** (integer) - The suggested width of the embed.
- **height** (integer) - The suggested height of the embed.
- **thumbnail_url** (string) - URL to a thumbnail of the flipbook.
- **thumbnail_width** (integer) - The width of the thumbnail.
- **thumbnail_height** (integer) - The height of the thumbnail.

#### Response Example
```json
{
  "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
}
```
```

--------------------------------

### Set Social Metadata for a Bookshelf

Source: https://heyzine.com/developers/index

Configures the social sharing metadata (title, description, thumbnail) for a specific bookshelf (library).

```APIDOC
### Set Social Metadata for a Bookshelf

### Description
Set the title, description, and thumbnail for the social sharing metadata of a specific bookshelf (library).

### Method
POST

### Endpoint
https://heyzine.com/api1/bookshelf-social

### Authorization
Bearer API_KEY

### Parameters
#### Request Body
- **id** (string) - Required - Bookshelf (library) identifier
- **title** (string) - Optional title for social sharing
- **description** (string) - Optional description for social sharing
- **thumbnail** (string URL) - URL pointing to an image for the social thumbnail

### Request Example
```json
{
  "id": "library1234567890abcdef",
  "title": "My Bookshelf Title",
  "description": "A description for social sharing.",
  "thumbnail": "https://example.com/library-image.jpg"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### List Flipbooks API

Source: https://heyzine.com/developers/index

Retrieves a list of all flipbooks within the authenticated account. It returns an array of flipbook objects, each containing details like ID, date, title, description, and various links.

```HTTP
GET https://heyzine.com/api1/flipbook-list
Authorization: Bearer API_KEY
```

--------------------------------

### Embed Flipbook using jQuery Plugin

Source: https://heyzine.com/developers/index

This jQuery plugin converts PDF links on a webpage into interactive flipbooks. It requires including jQuery and the Heyzine plugin via CDN or local files. Usage involves a simple function call on anchor tags, with options to customize the flipbook's appearance and behavior.

```javascript
<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>

$('a').pdfFlipbook({ key: 'd3m0' });
```

--------------------------------

### Leads Webhook

Source: https://heyzine.com/developers/index

Receive real-time notifications when new leads are collected from any lead generation form within your Heyzine account.

```APIDOC
## Webhooks - Leads

### Description
This webhook is triggered each time new leads are collected from any lead generation form associated with your Heyzine account. Configure your endpoint URL in the webhooks section of your account.

### Request Body Reference
```json
data: {
  "id_webhook": "Identifier of the event",
  "date": "Date and time (UTC) of the event request",
  "leads": [
    {
      "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": [
        {
          "label": "Question on the form",
          "value": "Lead answer"
        },
        // ... more answers
      ]
    },
    // ... more leads
  ]
}
```
```

--------------------------------

### Set Social Metadata for a Flipbook

Source: https://heyzine.com/developers/index

Configures the social sharing metadata (title, description, thumbnail) for a specific flipbook.

```APIDOC
## Social Metadata

### Set Social Metadata for a Flipbook

### Description
Set the title, description, and thumbnail for the social sharing metadata of a specific flipbook.

### Method
POST

### Endpoint
https://heyzine.com/api1/flipbook-social

### Authorization
Bearer API_KEY

### Parameters
#### Request Body
- **id** (string) - Required - Flipbook identifier
- **title** (string) - Optional title for social sharing
- **description** (string) - Optional description for social sharing
- **thumbnail** (string URL) - URL pointing to an image for the social thumbnail

### Request Example
```json
{
  "id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf",
  "title": "My Flipbook Title",
  "description": "A description for social sharing.",
  "thumbnail": "https://example.com/image.jpg"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### Fetch Flipbook Embed Code with oEmbed API

Source: https://heyzine.com/developers/index

The oEmbed API enables third-party services to retrieve HTML embed codes for Heyzine flipbooks. By providing a flipbook URL, you can obtain rich embed data, including an iframe to display the flipbook. This is useful for embedding flipbooks on external platforms.

```json
{
  "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
}
```

--------------------------------

### List Flipbooks

Source: https://heyzine.com/developers/index

Retrieves a list of all flipbooks associated with the account. This endpoint is useful for displaying or managing existing flipbooks.

```APIDOC
## List Flipbooks

### Description
Get a list of all the flipbooks in the account.

### Method
GET

### Endpoint
https://heyzine.com/api1/flipbook-list

### Authorization
Bearer API_KEY

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the flipbook.
- **date** (string) - The date and time the flipbook was created or last updated.
- **title** (string) - The title of the flipbook.
- **subtitle** (string) - The subtitle of the flipbook.
- **description** (string) - A description of the flipbook.
- **private** (string) - Internal management note.
- **pages** (integer) - The number of pages in the flipbook.
- **size** (integer) - The file size of the flipbook in bytes.
- **links** (object) - Contains URLs for accessing the flipbook and its assets.
  - **custom** (string) - Custom domain URL for the flipbook.
  - **base** (string) - Base URL for the flipbook.
  - **thumbnail** (string) - URL for the flipbook's thumbnail image.
  - **pdf** (string) - URL for the flipbook's PDF version.

### Response Example
```json
[
  {
    "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"
    }
  }
]
```
```

--------------------------------

### Set Bookshelf Social Metadata API

Source: https://heyzine.com/developers/index

Sets social sharing metadata for a bookshelf (library). This includes title, description, and a thumbnail image, customizing its appearance when shared.

```HTTP
POST https://heyzine.com/api1/bookshelf-social
Authorization: Bearer API_KEY
```

```JSON
{
  "id": "library1234567890abcdef",
  "title": "My Bookshelf Title",
  "description": "A description for social sharing.",
  "thumbnail": "https://example.com/library-image.jpg"
}
```

--------------------------------

### Add User Access

Source: https://heyzine.com/developers/index

Grants specific user access to a flipbook with various access types.

```APIDOC
### Add User Access

### Description
Grant user access to a flipbook.

### Method
POST

### Endpoint
https://heyzine.com/api1/access-add

### Authorization
Bearer API_KEY

### Parameters
#### Request Body
- **name** (string) - Required - Flipbook Identifier
- **access_type** (string) - Required - Type of access: "user_pass", "google", "pass_only", "otp", "email_link", "send_code". Note: "email_link" and "send_code" are Premium Plan features.
- **user** (string) - Required when access_type is "user_pass", "google", "email_link", or "send_code". User name or email for login.
- **password** (string) - Required when access_type is "user_pass", "pass_only", or "otp". Password for login.

### Request Example
```json
{
  "name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
  "access_type": "user_pass",
  "user": "reader@heyzine.com",
  "password": "mYp4ssW0rd"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the user was added successfully.
- **code** (integer) - The HTTP status code.
- **msg** (string) - A message confirming the addition.

#### Response Example
```json
{
  "success": true,
  "code": 200,
  "msg": "Added to the access list"
}
```
```

--------------------------------

### Set Flipbook Social Metadata API

Source: https://heyzine.com/developers/index

Configures social sharing metadata for a specific flipbook, including title, description, and thumbnail image. This allows customization of how the flipbook appears when shared on social platforms.

```HTTP
POST https://heyzine.com/api1/flipbook-social
Authorization: Bearer API_KEY
```

```JSON
{
  "id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf",
  "title": "My Flipbook Title",
  "description": "A description for social sharing.",
  "thumbnail": "https://example.com/image.jpg"
}
```

--------------------------------

### Configure Flipbook Password Protection API

Source: https://heyzine.com/developers/index

Configures password protection settings for a flipbook. This includes setting the access mode (users, everyone, disabled), and customizing the text displayed on the login page.

```HTTP
POST https://heyzine.com/api1/access-setup
Authorization: Bearer API_KEY
```

```JSON
{
  "name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
  "mode": "users",
  "text_user": "Please, type your email:",
  "text_password": "Please, type your password:"
}
```

--------------------------------

### Leads Webhook Request Body Structure

Source: https://heyzine.com/developers/index

This structure defines the JSON payload received by your endpoint when a new lead is generated through a Heyzine flipbook's lead generation form. It includes details about the lead, the associated flipbook, and the form answers.

```json
{
  "id_webhook": "Identifier of the event",
  "date": "Date an time (UTC) of the event request",
  "leads": [
    {
      "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": [
        {
          "label": "Question on the form",
          "value": "Lead answer"
        }
      ]
    }
  ]
}
```

--------------------------------

### Add User Access to Flipbook API

Source: https://heyzine.com/developers/index

Grants specific user access to a flipbook with various access types like username/password, Google sign-in, or password-only. This API is essential for managing who can view protected content.

```HTTP
POST https://heyzine.com/api1/access-add
Authorization: Bearer API_KEY
```

```JSON
{
  "name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
  "access_type": "user_pass",
  "user": "reader@heyzine.com",
  "password": "mYp4ssW0rd"
}
```

--------------------------------

### Remove User Access via API

Source: https://heyzine.com/developers/index

This API endpoint allows you to revoke a user's access to a specific flipbook. It requires the flipbook identifier and optionally user credentials for authentication. The response indicates whether the removal was successful.

```json
{
  "name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
  "user": "reader@heyzine.com"
}
```

--------------------------------

### Remove User Access

Source: https://heyzine.com/developers/index

Revokes a user's access to a specific flipbook. Requires flipbook identifier and user credentials.

```APIDOC
## POST /api1/access-remove

### Description
Revoke user access to a flipbook.

### Method
POST

### Endpoint
https://heyzine.com/api1/access-remove

### Headers
Authorization: Bearer API_KEY

### Parameters
#### Request Body
- **name** (string) - Required - Flipbook Identifier
- **user** (string) - Required when access_type is user_pass, google, email_link, or send_code - User name or email to be used on the flipbook login page.
- **password** (string) - Required when access_type is pass_only, or otp - Password to be used on the flipbook login page.

### Request Example
```json
{
  "name": "1f1aa4115833b3ee73a562ca27a422119ee22dc.pdf",
  "user": "reader@heyzine.com"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **code** (integer) - HTTP status code.
- **msg** (string) - Message indicating the result of the operation.

#### Response Example
```json
{
  "success": true,
  "code": 200,
  "msg": "Removed from the access list"
}
```
```

--------------------------------

### Delete Flipbook

Source: https://heyzine.com/developers/index

Deletes a specific flipbook from your account using its unique identifier.

```APIDOC
## Delete Flipbook

### Description
Delete an specific flipbook by its identifier.

### Method
POST

### Endpoint
https://heyzine.com/api1/flipbook-delete

### Authorization
Bearer API_KEY

### Parameters
#### Request Body
- **id** (string) - Required - Flipbook Identifier

### Request Example
```json
{
  "id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the deletion was successful.
- **code** (integer) - The HTTP status code.
- **msg** (string) - A message confirming the deletion.

#### Response Example
```json
{
  "success": true,
  "code": 200,
  "msg": "Flipbook deleted"
}
```
```

--------------------------------

### Delete Flipbook API

Source: https://heyzine.com/developers/index

Deletes a specific flipbook using its unique identifier. This operation requires the flipbook's ID in the request body and returns a success status.

```HTTP
POST https://heyzine.com/api1/flipbook-delete
Authorization: Bearer API_KEY
```

```JSON
{
  "id": "c16430e4c0cd91123474d0621b01b8f1f944f48ff85b1.pdf"
}
```
Tokens:
Raw