Recuperare i flipbook e i loro dettagli

Flipbook

Leggi i tuoi flipbook tramite l'API — recupera un singolo record per ID, cercane uno dal suo URL pubblico, scorri l'intera libreria e ottieni i suoi link al PDF e al viewer.

API usate in questa discussione

C'è qualcosa di inesatto o non aggiornato in questa guida?

Cosa puoi fare

Questi cinque endpoint di sola lettura coprono ogni modo in cui vorrai rileggere un flipbook da FlipLink — che tu abbia il suo ID numerico, solo il suo URL pubblico, o nient'altro che il desiderio di scorrere tutto ciò che possiedi:

Get one — il record completo di un flipbook tramite il suo flipbookId.
Find by URL — cerca un flipbook dal suo URL pubblico/di condivisione.
List — elenca i tuoi flipbook/documenti con la paginazione.
Get the PDF URL — il link S3 pubblico al PDF principale di un elemento.
Get the share link — l'URL pubblico del viewer di un elemento.

Prima di iniziare

Una chiave API — inviata in ogni richiesta come header X-Api-Key o come Authorization: Bearer YOUR_API_KEY.
Tutte le richieste vanno all'URL di base https://go.fliplink.me.
Tre di questi endpoint accettano un parametro {flipbookId} nel percorso — l'ID numerico del flipbook/documento, restituito da create-by-file / create-by-url (come ID) o da List. Gli altri due (Find by URL, List) accettano invece parametri nella query string.
Tutti e cinque sono richieste GET e non inviano alcun body.

Get one flipbook

GET /api/get/{flipbookId} restituisce il record completo di un singolo flipbook/documento per ID — ogni colonna memorizzata: titolo, URL, conteggi di visualizzazioni/lead/vendite, cartella e flag di stato. Il record completo viene restituito racchiuso in un oggetto Item con circa 190 colonne; l'esempio qui sotto è un sottoinsieme abbreviato e rappresentativo.

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

Risposta:

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

Trovare un flipbook per URL

GET /api/find-by-url cerca un flipbook dal suo URL pubblico/di condivisione e restituisce il suo record completo (stessa forma di Get one). Passa l'URL completo del viewer, un URL CNAME, o semplicemente lo slug CustomURL nudo nel parametro di query URL — il server prende l'ultimo segmento di percorso come 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'

Risposta (abbreviata — il record completo ha circa 190 colonne):

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

Elencare i tuoi flipbook

GET /api/list elenca i tuoi flipbook/documenti con la paginazione (PageNo/PageSize). Ogni elemento include ID, titolo, URL, conteggi di visualizzazioni/lead/vendite, cartella e flag di stato. Puoi anche filtrare con Folder e SearchText, paginare con PageNo, PageSize e Offset, e ordinare con SortBy e SortOrder.

SortBy accetta uno tra Name, DocType, CreatedOn, NoOfViews, NoOfLeads (vuoto = ordinamento predefinito; valori sconosciuti tornano al predefinito). SortOrder è ASC o DESC — ignorato se SortBy è vuoto, e i valori sconosciuti tornano silenziosamente al predefinito.

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'

Risposta:

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

Ottenere l'URL del PDF di un flipbook

GET /api/get-pdf/{flipbookId} restituisce l'URL S3 pubblico del PDF principale dell'elemento (versione unita se avvolto tra front/back).

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

Risposta:

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

Ottenere il link di condivisione di un flipbook

GET /api/get-share-link/{flipbookId} restituisce l'URL pubblico del viewer del flipbook (il suo prefisso di dominio personalizzato/host più lo slug di condivisione del flipbook).

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

Risposta:

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

Errori possibili

Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key (o Authorization: Bearer) sia presente e corretto. Questo vale per tutti e cinque gli endpoint.
flipbookId sconosciuto (o non di proprietà della tua chiave) → HTTP 200, messaggio Item not found. Questo vale per Get one, Get PDF URL e Get Share Link.

Note

Get one e Find by URL restituiscono entrambi la stessa forma di record completo racchiusa in un oggetto Item.
List racchiude i suoi risultati in un array Items e include i campi di paginazione (TotalRecordCount, TotalItems, UserItems, PageSize, Capped).
Get PDF URL e Get Share Link restituiscono ciascuno solo un singolo campo URL insieme a Result.

Discussioni correlate

Pagine di copertina, scadenza del link e fissaggio Creare un flipbook (da un PDF o da un URL)Eliminare un flipbook Organizzare i flipbook con cartelle e template Sostituire il PDF di un flipbook e duplicarlo