iPaper Technical Documentation

iPaper Technical Documentation

• iPaper Technical Documentation
• Google Analytics: Learn how to implement Google Analytics tracking in your Display
• Quick Start: The v1 Display JavaScript API allows for streamlined interaction a Display instance
• Commands: Commands are instructions issued by the page to the Display JavaScript API. Commands can be invoked by calling magic methods, which can be accessed directly from the API instance.
• Events: Display JavaScript API emits custom events that can be listened to on the document root
• Adobe Analytics events: How event tracking works on your flipbook when you add Adobe Analytics integration.
• Google Analytics / GTM events: How event tracking works on your flipbook when you add Google Analytics or Google Tag Manager integration.
• Overview
• Return Codes
• Ecommerce
• GetFlipbookOrdersByType
• GetLicenseOrdersByType
• Image
• GetImageWith2PxDropShadow
• Link
• GetLinks
• Media
• CreateDirectory
• DeleteDirectory
• DeleteFile
• GetTree
• UploadFile
• Paper
• ChangePaperUrl
• ClearPublicationPeriod
• CreateCategory
• CreatePaper
• CreatePreviewToken
• DeletePaper
• GetAllPapers
• GetPaperIDFromUrl
• GetPaperStructure
• GetPaperUrlFromID
• GetSetting
• GetSettingDescriptions
• MovePaper
• SetPublicationPeriod
• SetSetting
• Ripper
• GetProcessingPapers
• GetProcessingStatus
• ProcessPDF
• Search
• SearchPapersByContent
• SearchPapersByCustomFields
• SearchPapersWithHiearchyByContent
• SearchPapersWithHiearchyByName
• Statistics
• GetNumberOfPageviewsPerDay
• GetNumberOfVisitors
• GetNumberOfVisitorsPerDay
• Popup Content
• Popup Frame
• Custom Domain
• Custom Mail
• Embedding flipbooks inside iOS and Android App
• Form Integration
• Iframing Flipbooks
• iPaper Embed Script (Pop-ups)
• Embeds (Minipapers)
• Query String Parameters
• Remote Authentication
• Shop Export
• Getting Started: The Flipbook JavaScript API allows you to interact with flipbooks, executing commands and subscribing to events.
• Commands & Events
• Basket
• Consent
• Example Implementations
• UserCentrics
• OneTrust
• CookieInformation
• Cookiebot
• Paging
• Publication
• Search
• Table of Contents
• Sharing
• Advanced Usage
• Migration guide: This page will help you through the process of migrating an existing V2 implementation to the new V3 Flipbook JavaScript API. The new V3 API contains all the features from V2 as well as new ones.
• Legacy Javascript API (v2)
• Quick Start: The v2 Flipbook JavaScript API allows for streamlined interaction with iframed flipbooks using cross-origin communications available in modern browsers.
• Commands: Commands are instructions issued by the parent window to the iframed flipbook. Commands can be invoked by calling magic methods, which can be accessed directly from the API instance.
• Events
• Consent Management: Implement your own cookie consent solution for your Flipbook.
• Advanced Usage
• Cookie Information
• Common security questions
• Open Source

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.ipaper.io/readme.md?ask=<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.