Flipbooks und ihre Details abrufen

Was du tun kannst

Diese fünf schreibgeschützten Endpunkte decken jede Art ab, ein Flipbook aus FlipLink zurückzulesen – egal, ob du seine numerische ID hast, nur seine öffentliche URL oder nichts als den Wunsch, durch alles zu blättern, was dir gehört:

• Get one – der vollständige Datensatz eines Flipbooks über seine flipbookId.
• Find by URL – schlage ein Flipbook über seine öffentliche/geteilte URL nach.
• List – deine Flipbooks/Dokumente mit Paging.
• Get the PDF URL – der öffentliche S3-Link zum Haupt-PDF eines Items.
• Get the share link – die öffentliche Viewer-URL eines Items.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Drei dieser Endpunkte nehmen einen {flipbookId}-Pfad-Parameter entgegen – die numerische ID des Flipbooks/Dokuments, zurückgegeben von create-by-file / create-by-url (als ID) oder von List. Die anderen beiden (Find by URL, List) nehmen stattdessen Query-String-Parameter entgegen.
• Alle fünf sind GET-Anfragen und senden keinen Request-Body.

Ein Flipbook abrufen

GET /api/get/{flipbookId} gibt den vollständigen Datensatz eines einzelnen Flipbooks/Dokuments per ID zurück – jede gespeicherte Spalte: Titel, URLs, View-/Lead-/Sale-Zahlen, Ordner und Status-Flags. Der vollständige Datensatz wird in ein Item-Objekt eingepackt zurückgegeben mit ~190 Spalten; das Beispiel unten ist eine gekürzte, repräsentative Auswahl.

curl -X GET 'https://go.fliplink.me/api/get/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "Name": "My Document",
    "Title": "My Title",
    "DocType": "Flipbook",
    "IsPublished": true,
    "Pages": 8,
    "Folder": "Marketing",
    "SkinName": "Light Wood",
    "CustomURL": "my-document-96216",
    "ValidTillDate": "",
    "NoOfViews": 42,
    "NoOfLeads": 3,
    "NoOfSales": 0,
    "IsForSale": false,
    "IsLeadCapture": true,
    "IsPasswordProtected": false,
    "BookLayout": 1,
    "ScrollBehaviour": 1,
    "IsRightToLeft": false,
    "CoverType": "1",
    "PageDepth": "1",
    "FullURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172",
    "EmbedURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172"
  }
}

Ein Flipbook per URL finden

GET /api/find-by-url schlägt ein Flipbook über seine öffentliche/geteilte URL nach und gibt seinen vollständigen Datensatz zurück (gleiche Form wie Get one). Übergib die vollständige Viewer-URL, eine CNAME-URL oder nur den nackten CustomURL-Slug im Query-Parameter URL – der Server nimmt das letzte Pfadsegment als Slug.

curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https://go.fliplink.me/view/your-flipbook-slug' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort (gekürzt – der vollständige Datensatz hat ~190 Spalten):

{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "VendorID": "20000",
    "FilePDF": "/docs/20001/894abc58~demo_multipage.pdf",
    "Name": " coverage 20-Jun",
    "CreatedOn": "/Date(1781945608053)/",
    "NoOfViews": 1,
    "IsActive": true,
    "CustomURL": "your-flipbook-slug",
    "Title": "",
    "Description": " desc",
    "Pages": 8,
    "Folder": "-Folder",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsPublished": true,
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

Deine Flipbooks auflisten

GET /api/list listet deine Flipbooks/Dokumente mit Paging (PageNo/PageSize) auf. Jedes Item enthält IDs, Titel, URLs, View-/Lead-/Sale-Zahlen, Ordner und Status-Flags. Du kannst außerdem mit Folder und SearchText filtern, mit PageNo, PageSize und Offset blättern und mit SortBy und SortOrder sortieren.

SortBy akzeptiert eines von Name, DocType, CreatedOn, NoOfViews, NoOfLeads (leer = Standardsortierung; unbekannte Werte fallen auf den Standard zurück). SortOrder ist ASC oder DESC – wird ignoriert, wenn SortBy leer ist, und unbekannte Werte fallen stillschweigend auf den Standard zurück.

curl -X GET 'https://go.fliplink.me/api/list?Folder=&SearchText=&PageNo=1&PageSize=25&Offset=0&SortBy=&SortOrder=' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "Items": [
    {
      "ID": 93286,
      "Name": "INSPECT matrix Document - Copy 000",
      "Title": "MX Title",
      "CreatedOn": "Jun 12 2026  4:48PM",
      "CreatedOnIso": "2026-06-12T22:18:49.723+05:30",
      "CreatedDate": "Jun 12, 2026",
      "CreatedTime": " 4:48PM",
      "ValidTillDate": "",
      "NoOfViews": 0,
      "CustomURL": "0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "Password": "",
      "FilePDF": "/docs/20001/0DF318DC~dummy.pdf",
      "NoOfLeads": 0,
      "NoOfSales": 0,
      "FullURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "EmbedURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "IMGPdf": "/Content/assets/media/users/no-image.png",
      "Pages": 0,
      "IsUnpublished": "",
      "Folder": "",
      "IsTemplate": false,
      "CNAMEMessage": "",
      "DocType": "Document",
      "DocTypeColor": "danger",
      "SSL": "No",
      "CompressDataKey": "",
      "Optimised": "",
      "IsPinnedThumbnails": true,
      "IsApprovalButton": true,
      "NoOfApprovals": 0,
      "FrontPDF": "/docs/20001/730d7569~dummy.pdf",
      "MiddlePDF": "/docs/20001/4b34cbea~dummy.pdf",
      "BackPDF": "/docs/20001/e4454ad1~dummy.pdf"
    }
  ],
  "TotalRecordCount": 14,
  "TotalItems": 14,
  "UserItems": 14,
  "PageSize": 10,
  "Capped": false
}

Die PDF-URL eines Flipbooks abrufen

GET /api/get-pdf/{flipbookId} gibt die öffentliche S3-URL des Haupt-PDFs des Items zurück (die zusammengeführte Version, falls mit Titel-/Rückseite gehüllt).

curl -X GET 'https://go.fliplink.me/api/get-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Den Share-Link eines Flipbooks abrufen

GET /api/get-share-link/{flipbookId} gibt die öffentliche Viewer-URL des Flipbooks zurück (sein Custom-Domain-/Host-Präfix plus den Share-Slug des Flipbooks).

curl -X GET 'https://go.fliplink.me/api/get-share-link/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "URL": "https://go.fliplink.me/view/your-flipbook-slug"
}

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header (oder Authorization: Bearer) vorhanden und korrekt ist. Das gilt für alle fünf Endpunkte.
• Unbekannte flipbookId (oder eine, die nicht zu deinem Schlüssel gehört) → HTTP 200, Nachricht Item not found. Das gilt für Get one, Get PDF URL und Get Share Link.

Hinweise

• Get one und Find by URL geben beide dieselbe Form des vollständigen Datensatzes zurück, eingepackt in ein Item-Objekt.
• List packt seine Ergebnisse in ein Items-Array und enthält Paging-Felder (TotalRecordCount, TotalItems, UserItems, PageSize, Capped).
• Get PDF URL und Get Share Link geben jeweils nur ein einzelnes URL-Feld neben Result zurück.
• Nach einem Schreibvorgang erneut abrufen. Ein Result: OK bei einem Schreibvorgang bestätigt, dass die Anfrage angenommen wurde – nicht, dass ein Wert so geändert wurde, wie du es beabsichtigt hast. Zum Beispiel bleibt beim Senden eines leeren Werts der vorherige Wert erhalten, statt gelöscht zu werden. Rufe nach jedem Schreibvorgang den Datensatz erneut ab und vergleiche.