Récupérer des flipbooks et leurs détails

Flipbooks

Lis tes flipbooks via l'API — récupère un enregistrement unique par ID, retrouves-en un via son URL publique, parcours toute ta bibliothèque page par page, et obtiens ses liens PDF et lecteur.

API utilisées dans cette discussion

Une information inexacte ou obsolète dans ce guide ?

Ce que tu peux faire

Ces cinq endpoints en lecture seule couvrent toutes les façons dont tu voudras relire un flipbook depuis FlipLink — que tu disposes de son ID numérique, seulement de son URL publique, ou de rien d'autre que l'envie de parcourir tout ce que tu possèdes :

Get one — le dossier complet d'un flipbook via son flipbookId.
Find by URL — retrouve un flipbook à partir de son URL publique/de partage.
List — liste tes flipbooks/documents avec pagination.
Get the PDF URL — le lien S3 public du PDF principal d'un élément.
Get the share link — l'URL publique du lecteur d'un élément.

Avant de commencer

Une clé d'API — envoyée à chaque requête, soit dans l'en-tête X-Api-Key, soit via Authorization: Bearer YOUR_API_KEY.
Toutes les requêtes sont adressées à l'URL de base https://go.fliplink.me.
Trois de ces endpoints prennent un paramètre de chemin {flipbookId} — l'ID numérique du flipbook/document, renvoyé par create-by-file / create-by-url (sous ID) ou par List. Les deux autres (Find by URL, List) prennent plutôt des paramètres de chaîne de requête.
Les cinq sont des requêtes GET et n'envoient aucun corps de requête.

Get one flipbook

GET /api/get/{flipbookId} renvoie le dossier complet d'un seul flipbook/document par ID — chaque colonne stockée : titre, URLs, nombre de vues/prospects/ventes, dossier et indicateurs de statut. Le dossier complet est renvoyé encapsulé dans un objet Item avec environ 190 colonnes ; l'exemple ci-dessous est un sous-ensemble abrégé et représentatif.

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

Réponse :

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

Find a flipbook by URL

GET /api/find-by-url retrouve un flipbook via son URL publique/de partage et renvoie son dossier complet (même structure que Get one). Passe l'URL complète du lecteur, une URL CNAME, ou simplement le slug CustomURL nu dans le paramètre de requête URL — le serveur prend le dernier segment de chemin comme 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'

Réponse (abrégée — le dossier complet a environ 190 colonnes) :

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

List your flipbooks

GET /api/list liste tes flipbooks/documents avec pagination (PageNo/PageSize). Chaque élément inclut les IDs, le titre, les URLs, le nombre de vues/prospects/ventes, le dossier et les indicateurs de statut. Tu peux aussi filtrer avec Folder et SearchText, paginer avec PageNo, PageSize et Offset, et trier avec SortBy et SortOrder.

SortBy accepte l'une des valeurs Name, DocType, CreatedOn, NoOfViews, NoOfLeads (vide = tri par défaut ; les valeurs inconnues retombent sur le tri par défaut). SortOrder vaut ASC ou DESC — ignoré si SortBy est vide, et les valeurs inconnues retombent silencieusement sur le tri par défaut.

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'

Réponse :

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

Get a flipbook's PDF URL

GET /api/get-pdf/{flipbookId} renvoie l'URL S3 publique du PDF principal de l'élément (version fusionnée si un avant/arrière est habillé).

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

Réponse :

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

GET /api/get-share-link/{flipbookId} renvoie l'URL publique du lecteur du flipbook (son préfixe domaine personnalisé/hôte plus le slug de partage du flipbook).

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

Réponse :

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

Erreurs possibles

Clé d'API manquante ou invalide → HTTP 401. Renvoie une simple page HTML « Unauthorized » — il n'y a pas de corps JSON. Vérifie que l'en-tête X-Api-Key (ou Authorization: Bearer) est présent et correct. Cela s'applique à tous les cinq endpoints.
flipbookId inconnu (ou non rattaché à ta clé) → HTTP 200, message Item not found. Cela s'applique à Get one, Get PDF URL et Get Share Link.

Notes

Get one et Find by URL renvoient tous deux la même structure de dossier complet encapsulée dans un objet Item.
List encapsule ses résultats dans un tableau Items et inclut des champs de pagination (TotalRecordCount, TotalItems, UserItems, PageSize, Capped).
Get PDF URL et Get Share Link renvoient chacun juste un champ URL unique aux côtés de Result.

Discussions similaires

Pages de couverture, expiration du lien et épinglage Créer un flipbook (à partir d'un PDF ou d'une URL)Supprimer un flipbook Organiser les flipbooks avec des dossiers et des modèles Remplacer le PDF d'un flipbook et le dupliquer

Récupérer des flipbooks et leurs détails

API utilisées dans cette discussion

Ce que tu peux faire

Avant de commencer

Get one flipbook

Find a flipbook by URL

List your flipbooks

Get a flipbook's PDF URL

Get a flipbook's share link

Erreurs possibles

Notes

Discussions similaires