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. Link

GetLinks

Description

Exports all links from a given iPaper.

Note:

Superfluous nodes will be removed later on. Thus, for example, a rectangle link will in the future not include the polygoncoords node. When reading the response, you should handle potential missing nodes and degrade gracefully.

Parameters

Name
Value

paperID

The ID of the iPaper whose links should be returned

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<result>
  <code><![CDATA[SUCCESS]]></ code>
  <message><![CDATA[Links exported.]]></message>
  <data>
    <root>
      <link number="1">
        <number><![CDATA[2]]></number>
        <x><![CDATA[0.277648839556004]]></x>
        <y><![CDATA[0.231397006414825]]></y>
        <width><![CDATA[0.0671285252555119]]></width>
        <height><![CDATA[0.0132451983038164]]></height>
        <alttext><![CDATA[]]></alttext>
        <url><![CDATA[]]></url>
        <stylename><![CDATA[1']]></stylename>
        <shapetype><![CDATA[rectangle]]></shapetype>
        <polygoncoords><![CDATA[]]></polygoncoords>
        <linktype><![CDATA[shopitem]]></linktype>
        <fileid><![CDATA[]]></fileid>
        <target><![CDATA[]]></target>
        <usemask><![CDATA[True]]></usemask>
        <param><![CDATA[<item><name><![CDATA[FIBERROND. 3M 581C Ø127x22MM P60]]></name><price><![CDATA[2.75]]></price><descr><![CDATA[]]></descr><id><![CDATA[9900002430]]></id></item>]]></param>
      </link>
      <link number="2">
        <number><![CDATA[2]]></number>
        <x><![CDATA[0.114934409687185]]></x>
        <y><![CDATA[0.331147540983607]]></y>
        <width><![CDATA[0.0671285252555116]]></width>
        <height><![CDATA[0.0132451983038164]]></height>
        <alttext><![CDATA[]]></alttext>
        <url><![CDATA[]]></url>
        <stylename><![CDATA[1']]></stylename>
        <shapetype><![CDATA[rectangle]]></shapetype>
        <polygoncoords><![CDATA[]]></polygoncoords>
        <linktype><![CDATA[shopitem]]></linktype>
        <fileid><![CDATA[]]></fileid>
        <target><![CDATA[]]></target>
        <usemask><![CDATA[True]]></usemask>
        <param><![CDATA[<item><name><![CDATA[FIBERROND. 3M 581C Ø127X22MM P50]]></name><price><![CDATA[2.75]]></price><descr><![CDATA[]]></descr><id><![CDATA[9900002429]]></id></item>]]></param>
      </link>
</result>

Return Codes

  • SUCCESS

  • ERROR

PreviousLinkNextMedia

Last updated 2 years ago