Flipbooks en hun gegevens ophalen

Flipbooks

Lees je flipbooks via de API — haal één record op via ID, zoek er een op via de openbare URL, blader door je hele bibliotheek en verkrijg de PDF- en viewerlinks.

API's die in deze discussie worden gebruikt

Iets onjuist of verouderd in deze gids?

Wat je kunt doen

Deze vijf alleen-lezen endpoints dekken elke manier waarop je een flipbook uit FlipLink wilt teruglezen — of je nu de numerieke ID hebt, alleen de openbare URL, of niets meer dan de wens om door alles wat je bezit te bladeren:

Haal één flipbook op met het volledige record via de flipbookId.
Zoeken via URL — zoek een flipbook op via zijn openbare/deel-URL.
Lijst je flipbooks/documenten met paginering.
Haal de PDF-URL op — de openbare S3-link naar de hoofd-PDF van een item.
Haal de deellink op — de openbare viewer-URL van een item.

Voordat je begint

Een API-sleutel — meegestuurd op elk verzoek als de X-Api-Key-header of als Authorization: Bearer YOUR_API_KEY.
Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
Drie van deze endpoints nemen een {flipbookId}-padparameter — de numerieke ID van de flipbook/het document, teruggegeven door create-by-file / create-by-url (als ID) of door List. De andere twee (Find by URL, List) nemen in plaats daarvan query string-parameters.
Alle vijf zijn GET-verzoeken en sturen geen request-body.

Eén flipbook ophalen

GET /api/get/{flipbookId} geeft het volledige record voor één flipbook/document terug via ID — elke opgeslagen kolom: titel, URL's, weergave-/lead-/verkoopaantallen, map en statusvlaggen. Het volledige record wordt teruggegeven verpakt in een Item-object met ~190 kolommen; het voorbeeld hieronder is een ingekorte, representatieve selectie.

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

Response:

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

Een flipbook zoeken via URL

GET /api/find-by-url zoekt een flipbook op via zijn openbare/deel-URL en geeft het volledige record terug (zelfde vorm als Eén ophalen). Geef de volledige viewer-URL, een CNAME-URL of alleen de kale CustomURL-slug mee in de URL-queryparameter — de server neemt het laatste padsegment als de 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'

Response (ingekort — het volledige record heeft ~190 kolommen):

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

Je flipbooks opsommen

GET /api/list somt je flipbooks/documenten op met paginering (PageNo/PageSize). Elk item bevat ID's, titel, URL's, weergave-/lead-/verkoopaantallen, map en statusvlaggen. Je kunt ook filteren met Folder en SearchText, pagineren met PageNo, PageSize en Offset, en sorteren met SortBy en SortOrder.

SortBy accepteert een van Name, DocType, CreatedOn, NoOfViews, NoOfLeads (leeg = standaardvolgorde; onbekende waarden vallen terug op de standaard). SortOrder is ASC of DESC — genegeerd als SortBy leeg is, en onbekende waarden vallen stilzwijgend terug op de standaard.

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'

Response:

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

De PDF-URL van een flipbook ophalen

GET /api/get-pdf/{flipbookId} geeft de openbare S3-URL van de hoofd-PDF van het item terug (samengevoegde versie als er een front/back omheen zit).

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

Response:

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

De deellink van een flipbook ophalen

GET /api/get-share-link/{flipbookId} geeft de openbare viewer-URL van de flipbook terug (de prefix van zijn eigen domein/host plus de deel-slug van de flipbook).

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

Response:

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

Mogelijke fouten

Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Controleer of de X-Api-Key- (of Authorization: Bearer-)header aanwezig en correct is. Dit geldt voor alle vijf de endpoints.
Onbekende flipbookId (of een die niet bij je sleutel hoort) → HTTP 200, bericht Item not found. Dit geldt voor Eén ophalen, PDF-URL ophalen en Deellink ophalen.

Opmerkingen

Eén ophalen en Zoeken via URL geven beide dezelfde volledige-recordvorm terug, verpakt in een Item-object.
List verpakt zijn resultaten in een Items-array en bevat paginavelden (TotalRecordCount, TotalItems, UserItems, PageSize, Capped).
PDF-URL ophalen en Deellink ophalen geven elk maar één URL-veld terug, naast Result.

Gerelateerde discussies

Omslagpagina's, verlopen van links en vastpinnen Een flipbook maken (van een PDF of een URL)Een flipbook verwijderen Flipbooks ordenen met mappen en templates De PDF van een flipbook vervangen en hem dupliceren