LogoLogo
  • iPaper Technical Documentation
  • Display Analytics
    • Google Analytics
  • Display JavaScript API
    • Quick Start
    • Commands
    • Events
  • Flipbook Analytics
    • Adobe Analytics events
    • Google Analytics / GTM events
  • Flipbook Backend API
    • 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
      • ReprocessPaper
    • Search
      • SearchPapersByContent
      • SearchPapersByCustomFields
      • SearchPapersWithHiearchyByContent
      • SearchPapersWithHiearchyByName
    • Statistics
      • GetNumberOfPageviewsPerDay
      • GetNumberOfVisitors
      • GetNumberOfVisitorsPerDay
  • Flipbook Enrichment
    • Popup Content
    • Popup Frame
  • Flipbook Integration
    • 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
  • Flipbook JavaScript API
    • Getting Started
    • Commands & Events
      • Basket
      • Consent
        • Example Implementations
          • UserCentrics
          • OneTrust
          • CookieInformation
          • Cookiebot
      • Paging
      • Publication
      • Search
      • Table of Contents
      • Sharing
    • Advanced Usage
    • Migration guide
    • Legacy Javascript API (v2)
      • Quick Start
      • Commands
      • Events
      • Consent Management
      • Advanced Usage
  • Technical Information
    • Cookie Information
    • Common security questions
    • Open Source
Powered by GitBook
On this page
  • Description
  • Parameters
  • Sample Response
  • Return Codes
  1. Flipbook Backend API
  2. Paper

CreatePreviewToken

Description

Creates a preview SecurityToken that can be used to bypass any security on the Flipbook. After creating a token for a specific Flipbook, a specific client IP address and for a given time period, the Flipbook may be accessed using the URL: <urlToFlipbook>/?SecurityToken=<token> to bypass any security. This is typically used for scenarios where the user is logged in to an intranet and does not want to login to see the Flipbooks, while Flipbooks should be protected from public viewing. Instead of linking directly to the Flipbooks from the intranet, the intranet should link to a local page that creates the securitytoken and then redirects the user to the catalog.

Typical workflow:

  1. [Intranet] User clicks link to Flipbook.

  2. [Intranet] Requests security token from iPaper.

  3. [iPaper] Security token created & returned.

  4. [Intranet] Redirects user to actual Flipbook with securitytoken appended

Parameters

Name
Value

paperID

The ID of the iPaper that should be granted access to

validityMinutes

How long the security token should be valid for

ip

The IP that should be granted access. If this is en empty string, no IP validation will be performed and any IP presenting the correct token will be granted access

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<result>
  <code><![CDATA[SUCCESS]]></code>
  <message><![CDATA[Preview token created.]]></message>
  <data>
    <token><![CDATA[ffc8d256-c727-4bc7-9a32-67a929f4fa53]]></token>
  </data>
</result>

Return Codes

  • SUCCESS

  • ERROR

  • LOGIN_SECURITY_VIOLATION

PreviousCreatePaperNextDeletePaper

Last updated 2 years ago