API per sviluppatori · REST

Riferimento API di FlipLink

Crea flipbook e documenti, configura il viewer, acquisisci lead e gestisci domini personalizzati — tutto in modo programmatico. Autenticati con la tua API key e prova ogni endpoint dal vivo, direttamente da questa pagina.

URL di base https://go.fliplink.me

Ottieni una chiave →

Introduzione

L'API REST di FlipLink ti permette di creare e gestire flipbook e documenti in modo programmatico — caricare PDF, configurare il viewer, acquisire lead, gestire domini personalizzati e altro ancora. Ogni endpoint è raggiungibile sotto l'URL di base qui sotto e si autentica con la tua API key.

URL di base
https://go.fliplink.me

Autenticazione

Invia la tua API key a ogni richiesta. Sono supportati due stili di header — usa quello che il tuo client HTTP preferisce:

Header di autenticazione
X-Api-Key: YOUR_API_KEY
# — or —
Authorization: Bearer YOUR_API_KEY

Una chiave mancante o non valida viene respinta con HTTP 401 (una pagina HTML “Unauthorized” — non c'è alcun corpo JSON, quindi non provare a interpretarne uno su un 401). Una volta che la chiave è valida, ogni altro errore torna come HTTP 200 con Result: ERROR (vedi sotto). Tieni segreta la tua chiave — non esporla mai nel codice client che distribuisci agli utenti finali.

Formato delle risposte e tipi di risultato

Tutte le risposte sono in JSON e contengono un campo Result al primo livello — esistono esattamente due valori:

  • "Result": "OK" — successo. Gli endpoint di lettura aggiungono il loro payload; quelli di scrittura aggiungono un Message leggibile (ad es. "Updated successfully") e create/duplicate restituiscono il nuovo ID e URL.
  • "Result": "ERROR" — errore, con un Message che ne spiega il motivo.

Importante: solo gli errori di autenticazione (401), gli upload troppo grandi (413) e il superamento dei limiti di frequenza (429) usano uno stato HTTP diverso da 200. Tutto il resto — validazione, “non trovato”, regole di business — restituisce HTTP 200 con Result: ERROR, quindi controlla Result, non solo lo stato.

Paginazione

Gli endpoint di elenco accettano i parametri di query PageNo, PageSize e Offset. Omettili per dei valori predefiniti sensati.

Limiti di frequenza

Ogni API key è limitata a 300 richieste al minuto. La finestra è fissa e si azzera allo scoccare del minuto (non sono 60 secondi mobili). Ogni risposta riporta il budget attuale nei suoi header:

Header dei limiti di frequenza
X-RateLimit-Limit: 300          # requests allowed per minute
X-RateLimit-Remaining: 287      # requests left in the current window
X-RateLimit-Reset: 1781962140   # Unix epoch (seconds) when the window resets

Quando superi il limite ricevi HTTP 429. Aspetta fino a X-RateLimit-Reset (oppure rallenta e riprova) e tieni d'occhio X-RateLimit-Remaining per restare sotto il limite.

Limiti e quote del piano

La quota dei tuoi flipbook viene restituita nelle risposte di create e in get-subscription-details come Flipbooks_Count / Flipbooks_Max / Flipbooks_Left. La dimensione massima di upload è esposta come MaxFileSizeMB.

Errori

Condizioni comuni che dovresti gestire (più sotto, ogni endpoint elenca anche le proprie):

  • 401 — API key mancante o non valida (pagina HTML, niente JSON)
  • 413 — l'upload supera la dimensione massima dei file del piano
  • 429 — limite di frequenza superato; rallenta e riprova
  • 200 + Result:ERROR — tutto il resto: non trovato ("Item not found"), validazione ("Unknown field(s) …") o una regola di business ("This custom URL is already in use…", "File is not a valid PDF")

Profilo

Chi sono

Restituisce l'account proprietario della API key — ID utente/fornitore, nome, email, brand, URL dell'app e la dimensione massima di upload del piano (MaxFileSizeMB).

GEThttps://go.fliplink.me/api/whoami

Prerequisiti — nessuno. Questa è la chiamata radice: autentica la tua API key, il prerequisito di ogni altro endpoint.

Nessun parametro.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/whoami
curl -X GET 'https://go.fliplink.me/api/whoami' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Ottieni profilo

Restituisce il profilo dell'account associato alla API key — nome visualizzato, telefono e URL dell'immagine del profilo.

GEThttps://go.fliplink.me/api/get-profile
PrerequisitiChi sono(una API key valida)Ottieni profilo

Nessun parametro.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/get-profile
curl -X GET 'https://go.fliplink.me/api/get-profile' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Imposta profilo (parziale)

Aggiornamento parziale — i campi omessi mantengono i valori esistenti. È richiesto almeno un campo.

PUThttps://go.fliplink.me/api/set-profile
PrerequisitiChi sono(una API key valida)Imposta profilo (parziale)

Parametri del corpo

Namead es. Mark Stevens
Phonephonead es. +14155550142
ProfileImageURLad es. https://...

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-profile
curl -X PUT 'https://go.fliplink.me/api/set-profile' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Mark Stevens' \
  --data-urlencode 'Phone=+14155550142' \
  --data-urlencode 'ProfileImage=https://...'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri del corpo

Abbonamento e pagamenti

Ottieni dettagli abbonamento

Restituisce il piano e la quota attuali — nome del piano, stato, costi, data della prossima fattura, dimensione massima dei file, numero massimo di elementi/CNAME e i flag delle funzionalità.

GEThttps://go.fliplink.me/api/get-subscription-details
PrerequisitiChi sono(una API key valida)Ottieni dettagli abbonamento

Nessun parametro.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/get-subscription-details
curl -X GET 'https://go.fliplink.me/api/get-subscription-details' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Subscription": {
    "BrandName": "",
    "Name": "Your Account",
    "Mobile": "",
    "SubscriptionPlan": "LTD Individual",
    "SubscriptionFees": "USD 39.00",
    "Tax": "",
    "SubscriptionID": "#20000",
    "ActiveFrom": "12 Jun 2026",
    "Status": "Active",
    "NextInvoice": "01 Jan 2050",
    "Email": "you@example.com",
    "PhotoIMG": "/Content/assetsNew/media/avatars/blank.png",
    "MaxFileSizeBytes": 157286400,
    "MaxFileSize": "150",
    "MaxCNAME": "Unlimited",
    "AdvancedSharing": "Yes",
    "LeadEmailVerification": "Yes",
    "IsLTD": "Yes",
    "MaxItems": "200"
  }
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Elenca pagamenti

Restituisce lo storico di fatturazione — ogni acquisto/rinnovo di piano con ID ordine, importo, piano, data e numero di elementi.

GEThttps://go.fliplink.me/api/list-payments
PrerequisitiChi sono(una API key valida)Elenca pagamenti

Nessun parametro.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-payments
curl -X GET 'https://go.fliplink.me/api/list-payments' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [
    {
      "OrderID": "#10001",
      "Amount": "USD 39.00",
      "Plan": "LTD Individual / 822bf1b6",
      "Date": "12 Jun 2026",
      "DateIso": "2026-06-12T00:00:00+05:30",
      "InvoiceURL": "",
      "ItemCount": 100
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Elementi — creazione

Crea da file

Crea un flipbook (o un documento) da un PDF caricato, inviato come multipart/form-data. Il file viene archiviato, viene generata una miniatura e il record viene registrato.

Note
- Se ottieni un Flipbook o un Document dipende dall'header Host della richiesta — go.fliplink.me (predefinito) restituisce Flipbook, go.doclink.me restituisce Document.
- *_Count / *_Max / *_Left riflettono la quota del tuo piano dopo questa creazione.
- Usa l'ID restituito per le chiamate successive (set-meta, set-cta-primary, save-as-template, ecc.).
- La dimensione massima del file dipende dal piano (vedi MaxFileSizeMB da who-am-i).

POSThttps://go.fliplink.me/api/create-by-file
PrerequisitiChi sono(una API key valida)Crea da file

Corpo (multipart/form-data)

Filefile
Namead es. My Document
Titlead es. My Title
DocTypeenumFlipbook o Document. Su go.doclink.me viene sempre trattato come Document.Uno tra: Flipbook, Document

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

POST/api/create-by-file
curl -X POST 'https://go.fliplink.me/api/create-by-file' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file' \
  -F 'Name=My Document' \
  -F 'Title=My Title' \
  -F 'DocType=Flipbook'
Esempio di risposta200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Corpo (form-data)

Crea da URL

Crea un flipbook (o un documento) da un URL di un PDF. Il server scarica FileURL, lo carica su S3, genera una miniatura e registra il record.

Note
- Il prefisso dei nomi dei campi Flipbooks_* o Documents_* dipende dall'header Host della richiesta — go.fliplink.me (predefinito) restituisce Flipbook, go.doclink.me restituisce Document.
- *_Count / *_Max / *_Left riflettono la quota del piano dell'account dopo questa creazione.
- L'URL di origine deve rispondere entro 60s — origini lente o irraggiungibili falliscono con Source URL timed out after 60s. Per origini poco affidabili, conviene usare /api/create-by-file.

POSThttps://go.fliplink.me/api/create-by-url
PrerequisitiChi sono(una API key valida)Crea da URL

Parametri del corpo

FileURLURLad es. https://example.com/document.pdf
Namead es. My Document
Titlead es. My Title
DocTypeenumad es. FlipbookUno tra: Flipbook, Document

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200FileURL host is private / not allowed{ "Result": "ERROR", "Message": "FileURL host is not allowed." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

POST/api/create-by-url
curl -X POST 'https://go.fliplink.me/api/create-by-url' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FileURL=https://example.com/document.pdf' \
  --data-urlencode 'Name=My Document' \
  --data-urlencode 'Title=My Title' \
  --data-urlencode 'DocType=Flipbook'
Esempio di risposta200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri del corpo

Elementi — lettura

Ottieni singolo

Restituisce il record completo di un singolo flipbook/documento tramite ID — ogni colonna memorizzata: titolo, URL, conteggi di visualizzazioni/lead/vendite, cartella e flag di stato. Il record completo viene restituito incapsulato in un oggetto `Item` con circa 190 colonne; l'esempio qui sotto è un sottoinsieme abbreviato e rappresentativo.

GEThttps://go.fliplink.me/api/get/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Ottieni singolo

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/get/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "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"
  }
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Trova da URL

Cerca un flipbook tramite il suo URL pubblico/di condivisione e ne restituisce il record completo (stessa struttura di get).

GEThttps://go.fliplink.me/api/find-by-url
PrerequisitiChi sono(una API key valida)Trova da URL

Parametri di query

URLURLURL completo del viewer, un URL CNAME oppure il solo slug CustomURL. Il server prende l'ultimo segmento del percorso come slug.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/find-by-url
curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https%3A%2F%2Fgo.fliplink.me%2Fview%2F%3Cslug%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "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",
    "SkinID": -1,
    "LogoIMG": "",
    "LogoURL": "https://fliplink.me",
    "BackgroundIMG": "",
    "BackgroundDisplayFit": "",
    "BackgroundFillDirection": "",
    "ColorPanel": "#5A5F63",
    "ColorBackground": "#F2F2F2",
    "ColorLink": "#75869C",
    "FaviconIMG": "",
    "IsShare": true,
    "IsPrint": true,
    "IsDownload": false,
    "IsTextSelection": true,
    "IsThumbnails": true,
    "IsSound": false,
    "IsFullscreen": false,
    "IsZoom": false,
    "IsSearch": true,
    "IsPinnedThumbnails": false,
    "IsCTAButton": false,
    "CTAButtonText": "Buy",
    "CTAButtonColor": "#3366FF",
    "CTAButtonTextColor": "       ",
    "CTAButtonURL": "https://fliplink.me",
    "IsPasswordProtected": false,
    "Password": "",
    "IsLeadCapture": true,
    "LeadCaptureTitle": "",
    "IsLeadEmail": true,
    "IsLeadEmailMandatory": true,
    "IsLeadName": true,
    "IsLeadNameMandatory": false,
    "IsLeadPhone": false,
    "IsLeadPhoneMandatory": false,
    "IsLeadCompany": false,
    "IsLeadCompanyMandatory": false,
    "IsLeadDate": false,
    "IsLeadDateMandatory": false,
    "IsLeadCustom1": false,
    "IsLeadCustom1Mandatory": false,
    "Custom1Label": "",
    "IsLeadCustom2": false,
    "IsLeadCustom2Mandatory": false,
    "Custom2Label": "",
    "IsLeadPrivacyPolicy": false,
    "PrivacyPolicyURL": "",
    "IsLeadAllowSkip": true,
    "PageTurnMode": "Flip",
    "BookLayout": 1,
    "Shadowdepth": 1,
    "IsFixedZoomMode": false,
    "IsHardCover": false,
    "IsBookThickness": true,
    "IsLinkHighlight": true,
    "IsRightToLeft": false,
    "IMGPdf": "/Content/assets/media/users/no-image.png",
    "Pages": 8,
    "FacebookAnalyticsCode": "",
    "GoogleAnalyticsCode": "",
    "GoogleTagManager": "",
    "Folder": "-Folder",
    "PabblyWebhookURL_NewLead": "https://example.com/webhook-apitest",
    "TitleColor": "#3366FF",
    "CNAME": "",
    "IsNoIndex": false,
    "BackgroundMusic": "",
    "BackgroundMusicCustom": "",
    "AutoFlipInSecs": 0,
    "PwdTitle": "This is a private flipbook.\r\nTo view it, please enter the password.",
    "PwdPlaceholder": "Password",
    "PwdButton": "Submit",
    "LeadEmail": "Email",
    "LeadName": "Name",
    "LeadPhone": "Phone",
    "LeadCompany": "Company",
    "LeadDate": "Date",
    "LeadButton": "Submit",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsSendEmailOnView": false,
    "LeadFormAfterPages": 0,
    "CustomLoadingText": " loading",
    "IsShareButtons": true,
    "IsNotes": false,
    "IsCTAButton2": false,
    "CTAButtonText2": "More",
    "CTAButtonColor2": "#3366FF",
    "CTAButtonTextColor2": "       ",
    "CTAButtonURL2": "",
    "IsVerifyEmail": false,
    "IsVerifyMobile": false,
    "TwillioAPIKey": "",
    "IsShowControls": true,
    "NotificationsEmail": "antifragiletech@gmail.com",
    "GoogleSheetURL": "",
    "GoogleSheetIDKey": "",
    "GoogleSheetName": "",
    "PrivacyPolicyText": "",
    "PageDepth": "1",
    "CoverType": "1",
    "IsPublished": true,
    "LeadPhoneCountry": "",
    "LeadAfterPages": 0,
    "EmailsAllowed": "",
    "EmailVerifyTitleText": "antifragiletech@gmail.com",
    "EmailVerifyButtonText": "antifragiletech@gmail.com",
    "LeadSkipText": "",
    "OrdPos": 1,
    "IsStarred": false,
    "IsShowLogoMobile": true,
    "PreviewPDF": "",
    "IsForSale": false,
    "SaleCurr": "USD",
    "SaleAmount": 10,
    "SalePageTitle": "",
    "SaleAccessPageTitle": "",
    "SalePurchaseButtonText": "",
    "SaleButtonText": "",
    "SaleAccessButtonText": "",
    "SaleButtonColor": "#3366FF",
    "SaleGatewayName": "",
    "SaleGatewayKey": "",
    "SaleGatewaySecret": "",
    "EmailLeadSubject": "",
    "EmailLeadBody": " body",
    "EmailViewSubject": "antifragiletech@gmail.com",
    "EmailViewBody": "antifragiletech@gmail.com",
    "EmailSaleSubject": "antifragiletech@gmail.com",
    "EmailSaleBody": "antifragiletech@gmail.com",
    "TopLeft": "",
    "TopRight": "",
    "BottomLeft": "",
    "BottomRight": "",
    "IsCTAHiddenInPreview": false,
    "IsApprovalButton": false,
    "ApprovalButtonText": "Approve Document",
    "ApprovalButtonColor": "#000000",
    "ApprovalButtonTextColor": "#FFFFFF",
    "EmailApproveRequestSubject": "Document Approval Request: ##DOCUMENT_TITLE##",
    "EmailApproveRequestBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveRemindSubject": "Pending Document Approval: ##DOCUMENT_TITLE##",
    "EmailApproveRemindBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveSubmitSubject": "Document Approved: ##DOCUMENT_TITLE##",
    "EmailApproveSubmitBody": "<p>Hi,</p>\n<p>We are pleased to inform you that the following document has been approved:</p>\n<p>Name: <strong>##DOCU...",
    "IsBackgroundMusicLoop": false,
    "IsNavFirstLast": true,
    "IsShareFacebook": true,
    "IsShareTwitter": true,
    "IsShareWhatsApp": true,
    "IsShareTelegram": false,
    "IsShareLinkedIn": false,
    "IsSharePinterest": false,
    "IsShareReddit": false,
    "IsShareTumblr": false,
    "IsShareMessenger": false,
    "IsShareEmail": false,
    "IsShareLine": false,
    "IsShareWeChat": false,
    "IsShareInstagram": false,
    "IsShareFlipboard": false,
    "IsShareGeneral": false,
    "ScrollBehaviour": 1,
    "AIProvider": "",
    "AIKey": "",
    "IsVA": false,
    "VAButtonText": "",
    "VAButtonColor": "#3366FF",
    "VAButtonTextColor": "#3366FF",
    "VAText": "",
    "VAEmbeddings": "",
    "VAButtonStatus1": "0",
    "VAButtonStatus2": "0",
    "VAButtonStatus3": "0",
    "VAButtonStatus4": "0",
    "FrontPDF": "/docs/20001/f9496e75~dummy.pdf",
    "MiddlePDF": "/docs/20001/0b14ad4d~demo_multipage.pdf",
    "BackPDF": "/docs/20001/68504e6d~dummy.pdf",
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "WebhookURL_NewLead": "https://example.com/webhook-apitest",
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Elenca

Elenca i tuoi flipbook/documenti con paginazione (PageNo/PageSize). Ogni elemento include ID, titolo, URL, conteggi di visualizzazioni/lead/vendite, cartella e flag di stato.

GEThttps://go.fliplink.me/api/list
PrerequisitiChi sono(una API key valida)Elenca

Parametri di query

Folder
SearchText
PageNonumberad es. 1
PageSizenumberad es. 25
Offsetnumberad es. 0
SortByenumFacoltativo. Uno tra: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Vuoto = ordinamento predefinito; i valori sconosciuti ricadono sul predefinito.Uno tra: Name, DocType, CreatedOn, NoOfViews, NoOfLeads
SortOrderenumFacoltativo. `ASC` o `DESC`. Ignorato se SortBy è vuoto. I valori sconosciuti ricadono silenziosamente sul predefinito.Uno tra: ASC, DESC

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list
curl -X GET 'https://go.fliplink.me/api/list?Folder=%3CFolder%3E&SearchText=%3CSearchText%3E&PageNo=1&PageSize=25&Offset=0&SortBy=%3CSortBy%3E&SortOrder=%3CSortOrder%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "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
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Ottieni URL del PDF

Restituisce l'URL pubblico S3 del PDF principale dell'elemento (versione unita se è presente un wrap fronte/retro).

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Ottieni URL del PDF

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/get-pdf/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Elementi — modifica

Duplica

Crea una o più copie lato server di un flipbook — ogni copia riceve un nuovo ID e un URL di condivisione propri. Puoi duplicarne fino a 20 alla volta (Count).

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Duplica

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

Countnumber1–500 (limitato lato server)

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

POST/api/duplicate/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/duplicate/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Count=3'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sostituisci PDF (file)

Upload multipart. Riesegue automaticamente il merge con il fronte/retro esistente, se presente.

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Sostituisci PDF (file)

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Corpo (multipart/form-data)

Filefile

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/replace-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Corpo (form-data)

Sostituisci PDF (URL)

Sostituisce il PDF di un flipbook esistente con uno che il server scarica da un URL che fornisci tu. Il flipbook mantiene il suo ID, le impostazioni e il link di condivisione.

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Sostituisci PDF (URL)

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

FileURLad es. https://example.com/new.pdf

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/replace-pdf-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'File=https://example.com/new.pdf'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Salva come modello (toggle)

Contrassegna il flipbook come modello riutilizzabile (Status=true) oppure lo rimuove dai modelli (Status=false). I modelli compaiono in list-templates e possono fare da base per nuovi flipbook.

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Salva come modello (toggle)

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

Statustrue | falsetrue/false. Predefinito true se omesso.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/save-as-template/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/save-as-template/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Saved as template"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Assegna a cartella

Sposta il flipbook in una cartella per organizzarlo. Le cartelle vengono create su richiesta — assegna il flipbook a un nome di cartella che non esiste ancora e viene creata automaticamente (non esiste una chiamata separata per 'creare una cartella'). Invia un Folder vuoto per togliere il flipbook dalla sua cartella. Una cartella esiste solo finché contiene almeno un flipbook, quindi spostando fuori l'ultimo flipbook la cartella scompare da list-folders. I nomi delle cartelle possono contenere / (ad es. Marketing/Q2).

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Assegna a cartella

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

FolderNome della cartella in cui spostare il flipbook — creata se non esiste (oppure riutilizza un nome da list-folders). Invia vuoto per rimuovere l'assegnazione.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/assign-to-folder/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta pagina fronte/retro (file)

Fronte/retro opzionali, uno o entrambi — ne serve almeno uno. Riesegue il merge con il PDF principale esistente.

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta pagina fronte/retro (file)

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Corpo (multipart/form-data)

Frontfile
Backfile

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Corpo (form-data)

Imposta pagina fronte/retro (URL)

Variante via URL di set-front-back-page — allega le pagine di copertina/retro da un URL di un PDF remoto invece che da un file caricato.

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta pagina fronte/retro (URL)

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

FrontURLad es. https://example.com/front.pdf
BackURLad es. https://example.com/back.pdf

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-front-back-page-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Rimuovi pagina fronte/retro

Rimuove il wrap fronte/retro, ripristinando FilePDF al PDF centrale senza wrap (MiddlePDF). Idempotente — un flipbook senza wrap restituisce OK e non cambia nulla. Restituisce { Result, Message, URL (URL S3 del PDF centrale) }. I vecchi oggetti S3 uniti/fronte/retro non vengono eliminati.

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Rimuovi pagina fronte/retro

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/clear-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Imposta scadenza / Rimuovi scadenza

Imposta o rimuove la scadenza automatica di un flipbook. Invia Days + Hours come interi; Days=-1, Hours=0 rimuove del tutto la scadenza.

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta scadenza / Rimuovi scadenza

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

DaysnumberUsa -1 per rimuovere la scadenza
HoursnumberFacoltativo, predefinito 0

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-expiry/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-expiry/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta pin (toggle)

Fissa o rimuove il pin dal flipbook (lo stato di preferito) in modo che venga ordinato in cima alla tua dashboard.

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta pin (toggle)

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

CorrelatiElenca
PUT/api/set-pin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Elementi — eliminazione

Elimina

Elimina in modo permanente il record del flipbook dal database. Nota: i file S3 sottostanti NON vengono rimossi automaticamente.

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Elimina

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

DELETE/api/delete/{flipbookId}
curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

CNAME (domini personalizzati)

Aggiungi CNAME

Collega un dominio personalizzato (CNAME) già attivato a un flipbook. Il dominio deve prima essere aggiunto e verificato dalla dashboard web (che provvede a DNS + SSL); questo endpoint si limita a salvare l'associazione — non verifica il DNS né emette certificati.

Prerequisiti:
- Il CNAME deve già esistere nel tuo account (aggiunto dalla dashboard). Altrimenti: Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- Deve rientrare nel limite di CNAME del tuo piano.

Parametri:
- CNAME (obbligatorio) — hostname completo, ad es. docs.example.com
- IsCloudflare (facoltativo, predefinito 0).

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Aggiungi CNAME

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

CNAMEad es. docs.example.com
IsCloudflaretrue | falseFacoltativo. 0 (predefinito) o 1. Passa 1 se il tuo DNS è dietro il proxy di Cloudflare.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

POST/api/add-cname/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/add-cname/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CNAME=docs.example.com' \
  --data-urlencode 'IsCloudflare=0'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Elenca CNAME

Tutti i CNAME personalizzati del chiamante. Ogni elemento: { CNAME, Documents (numero di flipbook attivi), FlipbookIDs ([...] con gli ID dei flipbook attivi associati a quel CNAME) }.

GEThttps://go.fliplink.me/api/list-cnames
PrerequisitiChi sono(una API key valida)Elenca CNAME

Nessun parametro.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-cnames
curl -X GET 'https://go.fliplink.me/api/list-cnames' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Elimina CNAME

Rimuove l'associazione di un dominio personalizzato (CNAME) da uno o tutti i tuoi flipbook. Due modalità:

  • In blocco (predefinita): passa CNAME=<host> e lascia vuoto FlipbookID — rimuove quel CNAME da ogni flipbook che possiedi.
  • Per singolo flipbook: passa FlipbookID=<id> — il CNAME viene ricavato da quel flipbook. Usala per un'azione 'Rimuovi CNAME' sulla singola riga.

Risposta (per singolo flipbook): { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
Risposta (in blocco): { "Result": "OK", "Message": "CNAME removed successfully" }
Mancano entrambi: { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

Nota: passa il CNAME come parametro di query (non come segmento di URL) per evitare problemi con i punti nell'hostname.

DELETEhttps://go.fliplink.me/api/delete-cname
PrerequisitiChi sono(una API key valida)Elenca CNAME(trova il CNAME / FlipbookID)Elimina CNAME

Parametri di query

CNAMEObbligatorio per la modalità IN BLOCCO (rimuove il CNAME da ogni flipbook che possiedi). Ignorato quando FlipbookID > 0 — in quel caso il CNAME viene preso da quel flipbook.
FlipbookIDnumberFacoltativo. Passa un ID di flipbook > 0 per rimuovere il CNAME SOLO da quel flipbook (modalità per singolo flipbook). Lascia vuoto/ometti/0 per la modalità in blocco (rimozione da tutti).

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

DELETE/api/delete-cname
curl -X DELETE 'https://go.fliplink.me/api/delete-cname?CNAME=docs.example.com&FlipbookID=%3CFlipbookID%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Cartelle

Elenca cartelle

Elenca le tue cartelle, ciascuna come { Folder (nome), URL (un GUID della cartella) }. Le cartelle derivano dalle assegnazioni dei flipbook (create tramite assign-to-folder), quindi una cartella vuota non viene elencata. I nomi delle cartelle alimentano assign-to-folder (per collocare un flipbook) e set-team-member (per delimitare l'accesso di un membro del team).

GEThttps://go.fliplink.me/api/list-folders
PrerequisitiChi sono(una API key valida)Elenca cartelle

Nessun parametro.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-folders
curl -X GET 'https://go.fliplink.me/api/list-folders' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Membri del team

Elenca membri del team

Elenca i membri del team (utenti del fornitore) del tuo account con i relativi dettagli di accesso, incluse le cartelle a cui ciascun membro è assegnato. Le password non vengono mai restituite. Filtra per IsActive.

GEThttps://go.fliplink.me/api/list-team-members
PrerequisitiChi sono(una API key valida)Elenca membri del team

Parametri di query

IsActivetrue | false1=attivi (predefinito), 0=inattivi

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-team-members
curl -X GET 'https://go.fliplink.me/api/list-team-members?IsActive=1' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Ottieni membro del team

Restituisce un singolo membro del team tramite il suo member ID (l'ID da list-team-members) — nome, email, stato attivo e le cartelle a cui il membro è assegnato. Un membro del team è limitato alle cartelle impostate tramite set-team-member (il campo Folders), quindi può accedere solo ai flipbook all'interno di quelle cartelle. Le password non vengono mai restituite. Il memberId è l'ID del membro del team (da List Team Members) — non un ID di flipbook; passare un ID di flipbook restituisce "Team member not found". Il membro viene restituito incapsulato in un oggetto Item; Folders è un elenco separato da virgole delle cartelle a cui può accedere (vuoto = nessuna restrizione di cartella).

GEThttps://go.fliplink.me/api/get-team-member/{memberId}
PrerequisitiChi sono(una API key valida)Imposta membro del team (crea o aggiorna)(crea prima un membro)Ottieni membro del team

Parametri di percorso

memberIdnumberID del membro del team (da list-team-members). NON un ID di flipbook.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200No team member with that ID (e.g. you passed a flipbook ID){ "Result": "ERROR", "Message": "Team member not found" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/get-team-member/{memberId}
curl -X GET 'https://go.fliplink.me/api/get-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Imposta membro del team (crea o aggiorna)

Crea un nuovo membro del team (utente del fornitore) oppure ne aggiorna uno esistente — controllando chi può accedere al tuo account e, tramite il campo Folders, a quali cartelle è limitato (un membro vede solo i flipbook all'interno delle cartelle assegnate). In caso di successo viene scritta una voce nel log di audit.

Errori comuni: il nome del membro è un unico campo Name — non esistono FirstName/LastName. Folders è un elenco separato da virgole di nomi di cartelle da List Folders (ad es. Marketing,Sales); lascialo vuoto per nessuna restrizione di cartella. La creazione di un membro restituisce { Result:"OK", Message:"Team member created" } (il percorso di aggiornamento — quando viene fornito ID — restituisce "Updated successfully"). L'email del membro non deve appartenere già a un utente FlipLink, e le email con alias + vengono rifiutate.

POSThttps://go.fliplink.me/api/set-team-member
PrerequisitiChi sono(una API key valida)Elenca cartelle(nomi per l'ambito Folders)Imposta membro del team (crea o aggiorna)

Parametri del corpo

Namead es. Jane
Emailemailad es. jane@example.com
IDnumberOmetti o -1 per creare. >0 per aggiornare.
PasswordTesto in chiaro; cifrato lato server. Vuoto in aggiornamento mantiene il valore esistente.
ProfileImageURL
FoldersCartelle a cui questo membro è limitato — un elenco delimitato di nomi di cartelle (da list-folders). Il membro può accedere solo ai flipbook all'interno di queste cartelle.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

POST/api/set-team-member
curl -X POST 'https://go.fliplink.me/api/set-team-member' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Jane' \
  --data-urlencode 'Email=jane@example.com' \
  --data-urlencode 'ID=-1' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'ProfileImage=<ProfileImage>' \
  --data-urlencode 'Folders=<Folders>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Team member created"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri del corpo

Imposta attività membro del team

Attiva o disattiva un membro del team, controllando se può accedere e usare l'account.

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}
PrerequisitiChi sono(una API key valida)Imposta membro del team (crea o aggiorna)(crea prima un membro)Imposta attività membro del team

Parametri di percorso

memberIdnumberID del membro del team (da list-team-members). NON un ID di flipbook.

Parametri del corpo

IsActivetrue | falsead es. true

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-team-member-active/{memberId}
curl -X PUT 'https://go.fliplink.me/api/set-team-member-active/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsActive=true'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Elimina membro del team

Eliminazione soft (disattivazione). I membri del team non vengono mai eliminati in modo definitivo — questa operazione disattiva il membro (un alias REST di set-team-member-active con IsActive=false). Il loro storico dei pagamenti e i riferimenti di audit restano intatti, e possono essere riattivati in seguito tramite PUT /api/set-team-member-active (IsActive=true).

Risposta: { "Result": "OK", "Message": "Team member deactivated" }.

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}
PrerequisitiChi sono(una API key valida)Imposta membro del team (crea o aggiorna)(crea prima un membro)Elimina membro del team

Parametri di percorso

memberIdnumberID del membro del team (da list-team-members). NON un ID di flipbook.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

DELETE/api/delete-team-member/{memberId}
curl -X DELETE 'https://go.fliplink.me/api/delete-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Team member deactivated"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Lead e vendite

Elenca lead

Elenca le acquisizioni di lead raccolte dai tuoi flipbook. Restituisce Items[] più uno schema dinamico Columns[] (per costruire una tabella) e TotalRecordCount. Supporta la paginazione e l'esportazione CSV tramite IsDownload.

GEThttps://go.fliplink.me/api/list-leads
PrerequisitiChi sono(una API key valida)Elenca lead

Parametri di query

ItemIDsID di flipbook separati da virgola O da barra verticale (vuoto = tutti)
SearchText
PageNonumberad es. 1
Offsetnumberad es. 0
IsDownloadtrue | falsead es. true

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-leads
curl -X GET 'https://go.fliplink.me/api/list-leads?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Elenca vendite

Elenca i record di vendita/acquisto dei tuoi flipbook (email dell'acquirente, flipbook, importo, data) più le definizioni delle colonne per la tabella delle vendite. Supporta la paginazione e l'esportazione CSV tramite IsDownload.

GEThttps://go.fliplink.me/api/list-sales
PrerequisitiChi sono(una API key valida)Elenca vendite

Parametri di query

ItemIDs
SearchText
PageNonumberad es. 1
Offsetnumberad es. 0
IsDownloadtrue | falsead es. true
IsAbandonedtrue | falsetrue → restituisce le vendite con carrello abbandonato invece delle vendite completate

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-sales
curl -X GET 'https://go.fliplink.me/api/list-sales?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true&IsAbandoned=false' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Elimina lead

Elimina un singolo lead acquisito tramite il suo ID. Il segmento del percorso è il leadId; passa anche l'Email del lead e il suo FlipbookID come parametri di query.

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}
PrerequisitiChi sono(una API key valida)Elenca lead(ottieni un ID di lead)Elimina lead

Parametri di percorso

leadIdnumberL'ID del lead (il LeadID da list-leads).

Parametri di query

Emailemailad es. foo@example.com
FlipbookIDnumberad es. {{flipbookId}}

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

DELETE/api/delete-lead/{leadId}
curl -X DELETE 'https://go.fliplink.me/api/delete-lead/{leadId}?Email=foo%40example.com&FlipbookID=%7B%7BflipbookId%7D%7D' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri di query

Elimina lead (in blocco)

Elimina lead in blocco in base a un filtro. È RICHIESTO almeno UNO tra FlipbookID/Email/DateFrom/DateTo — una chiamata senza filtri viene rifiutata (non esiste un percorso 'elimina tutto'). Sempre delimitato al fornitore. Restituisce { Result, Deleted (conteggio) }. Ripulisce anche le righe figlie (log delle visualizzazioni / click sulle CTA / log di esportazione del foglio).

DELETEhttps://go.fliplink.me/api/delete-leads
PrerequisitiChi sono(una API key valida)Crea da file(delimita per FlipbookID)Elimina lead (in blocco)

Parametri di query

FlipbookIDnumberFacoltativo. Elimina i lead solo di questo flipbook.
EmailemailFacoltativo. Email con corrispondenza ESATTA.
DateFromFacoltativo. Elimina i lead acquisiti a partire da questa data (compresa) (corrisponde a Lead.CreatedOn). Qualsiasi data interpretabile, ad es. 2026-01-01 o 2026-01-01T00:00:00Z.
DateToFacoltativo. Elimina i lead acquisiti fino a questa data (compresa).

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

DELETE/api/delete-leads
curl -X DELETE 'https://go.fliplink.me/api/delete-leads?FlipbookID=%7B%7BflipbookId%7D%7D&Email=%3CEmail%3E&DateFrom=%3CDateFrom%3E&DateTo=%3CDateTo%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Imposta acquisto flipbook

Registra una vendita (acquisto) di flipbook completata — usala per registrare gli acquisti effettuati tramite il tuo flusso di pagamento, senza passare dal checkout Stripe di FlipLink.

Parametro di percorso: {flipbookId} — il flipbook che viene contrassegnato come acquistato.

Corpo (urlencoded):
- Email — email dell'acquirente (obbligatorio)
- PaymentRef — il riferimento del tuo gateway di pagamento, ad es. un ID PaymentIntent di Stripe (obbligatorio)

Risposta (successo): { "Result": "OK", "Message": "Purchase recorded successfully" }
Risposta (errore): { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

Errori comuni: invia PaymentRef; NON inviare Amount/Currency — quei valori vengono ricavati lato server dal tuo riferimento di pagamento.

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisto flipbook

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

EmailemailIndirizzo email dell'acquirente (obbligatorio).
PaymentRefRiferimento del payment-intent dal gateway (obbligatorio). Per Stripe è l'ID PaymentIntent (`pi_...`).

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

POST/api/set-flipbook-purchase/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Email=customer@example.com' \
  --data-urlencode 'PaymentRef=pi_3O1234567890abcdef'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Lookup

Elenca modelli

Elenca i modelli di flipbook riutilizzabili salvati sul tuo account. Filtra per DocType (0 = tutti). Usa l'ID di un modello nei flussi save-as-template / create.

GEThttps://go.fliplink.me/api/list-templates
PrerequisitiChi sono(una API key valida)Elenca modelli

Parametri di query

DocTypenumber0 = Flipbook (predefinito), 1 = Document

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-templates
curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Elenca skin

Elenca le skin/i temi disponibili per il viewer; ogni riga riporta l'URL dello sfondo incluso nella skin. Usa il nome di una skin con set-skin.

GEThttps://go.fliplink.me/api/list-skins
PrerequisitiChi sono(una API key valida)Elenca skin

Parametri di query

Typetrue | false0=skin per Flipbook, 1=skin per Document

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

CorrelatiImposta skin
GET/api/list-skins
curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di query

Elenca valute

Elenca le valute disponibili per la vendita di un flipbook (per le impostazioni di vendita/checkout).

GEThttps://go.fliplink.me/api/list-currencies
PrerequisitiChi sono(una API key valida)Elenca valute

Nessun parametro.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-currencies
curl -X GET 'https://go.fliplink.me/api/list-currencies' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Elenca musica di sottofondo

Elenca le tracce di musica di sottofondo integrate che puoi associare al viewer di un flipbook.

GEThttps://go.fliplink.me/api/list-background-music
PrerequisitiChi sono(una API key valida)Elenca musica di sottofondo

Nessun parametro.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

GET/api/list-background-music
curl -X GET 'https://go.fliplink.me/api/list-background-music' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Sezioni — branding e contenuti

Imposta meta

Imposta il titolo del flipbook e i meta SEO — Title, Description, TitleColor e il flag IsPublished.

Nota: questa operazione sovrascrive Title/Description/TitleColor. Per cambiare solo lo stato di pubblicazione, usa set-published.

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta meta

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

Title
Description
TitleColor
IsPublishedtrue | falsead es. false

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-meta/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-meta/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=<Title>' \
  --data-urlencode 'Description=<Description>' \
  --data-urlencode 'TitleColor=<TitleColor>' \
  --data-urlencode 'IsPublished=false'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta pubblicazione (pubblica / annulla pubblicazione)

Pubblica o annulla la pubblicazione del flipbook — cambia SOLO il flag di pubblicazione, lasciando intatti Title/Description/TitleColor (a differenza di set-meta). Usala per (ri)pubblicare un flipbook, ad es. uno tornato non pubblicato da create-by-file.

PUThttps://go.fliplink.me/api/set-published/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta pubblicazione (pubblica / annulla pubblicazione)

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsPublishedtrue | falsetrue/1 = pubblica, false/0 = annulla pubblicazione (obbligatorio).

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

CorrelatiImposta meta
PUT/api/set-published/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-published/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta skin

Applica una skin/un tema del viewer al flipbook; il server risolve il nome della skin nel suo ID.

Errori comuni: il campo è SkinName (la stringa da list-skins), non un ID numerico.

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Elenca skin(scegli uno SkinName)Imposta skin

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

SkinNameDa /api/list-skins → colonna Name

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

CorrelatiElenca skin
PUT/api/set-skin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-skin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName=<SkinName>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta immagine di sfondo

Imposta l'immagine di sfondo del viewer da un URL che fornisci tu (non c'è una galleria integrata).

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta immagine di sfondo

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

BackgroundIMGURLURL dell'immagine OPPURE un URL segnaposto come https://plchldr.co/i/100x100?text=&bg=HEX

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-background-image/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-image/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundIMG=<BackgroundIMG>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta favicon

Imposta la favicon (l'icona della scheda del browser) usata dalla pagina del viewer ospitato del flipbook.

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta favicon

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

FaviconIMGURL

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

CorrelatiImposta logo
PUT/api/set-favicon/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-favicon/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG=<FaviconIMG>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta aspetto delle pagine

Configura l'aspetto delle pagine del viewer — sfondo, ombra delle pagine, spaziatura e altre opzioni estetiche correlate. I valori vengono salvati alla lettera; gli elementi più datati possono riportare altri valori (ad es. regular, o il numerico 1) quando vengono riletti tramite Get one.

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta aspetto delle pagine

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

PageDepthenumflat | thin | thickUno tra: flat, thin, thick
CoverTypeenumsoft | hardUno tra: soft, hard

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-page-appearance/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta testo di caricamento

Imposta il testo personalizzato mostrato nella schermata di caricamento del viewer.

Errori comuni: il campo è CustomLoadingText, non LoadingText.

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta testo di caricamento

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

CustomLoadingText

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-loading-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-loading-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText=<CustomLoadingText>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta URL personalizzato

Imposta lo slug personalizzato (vanity) per l'URL di condivisione del flipbook. Deve essere univoco; uno slug già in uso restituisce Result:ERROR.

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta URL personalizzato

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

CustomURL

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Custom URL already taken{ "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-custom-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-custom-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=<CustomURL>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta PDF di anteprima

Imposta il PDF di anteprima mostrato ai lettori prima dell'acquisizione del lead / del pagamento. Viene cancellato automaticamente se sia l'acquisizione dei lead sia la modalità di vendita sono disattivate.

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta PDF di anteprima

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

PreviewPDFURL

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-preview-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=<PreviewPDF>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta PDF immagine

Imposta il PDF di sole immagini/anteprima usato per le miniature e le anteprime. Invia vuoto per mantenere il PDF immagine esistente.

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta PDF immagine

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IMGPdfURL

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-image-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=<IMGPdf>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — viewer e lettore

Imposta controlli del viewer

Mostra o nasconde i singoli pulsanti della barra degli strumenti del viewer (download, stampa, condivisione, schermo intero, zoom, miniature, ecc.).

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta controlli del viewer

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsShowControlstrue | falsead es. true
IsPrinttrue | falsead es. false
IsDownloadtrue | falsead es. false
IsThumbnailstrue | falsead es. true
IsSearchtrue | falsead es. true
IsSoundtrue | falsead es. true
IsFullscreentrue | falsead es. true
IsZoomtrue | falsead es. true
IsNotestrue | falsead es. false

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-viewer-controls/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta navigazione del lettore

Configura la navigazione del lettore nel viewer — miniature delle pagine, indice e come i lettori passano da una pagina all'altra.

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta navigazione del lettore

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsNavFirstLasttrue | falsead es. true
BookLayoutenum1=singola, 2=doppiaUno tra: 1, 2
IsRightToLefttrue | falsead es. false
ScrollBehaviournumberModalità di scorrimento numerica

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-reader-navigation/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta sfoglio automatico

Abilita o disabilita lo sfoglio automatico delle pagine nel viewer e il relativo intervallo.

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta sfoglio automatico

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

AutoFlipInSecsnumberMILLISECONDI nonostante il nome. 0 = off, 3000 = 3s, 5000 = 5s, ecc.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-auto-flip/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta musica di sottofondo

Imposta o rimuove la traccia di musica di sottofondo che viene riprodotta nel viewer. Vedi list-background-music per le tracce disponibili.

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Elenca musica di sottofondo(scegli una traccia)Imposta musica di sottofondo

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

BackgroundMusicNome del file della traccia predefinita (da /api/list-background-music)
BackgroundMusicCustomURLURL della musica caricata personalizzata
IsBackgroundMusicLooptrue | falsead es. false

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-background-music/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-music/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=<BackgroundMusic>' \
  --data-urlencode 'BackgroundMusicCustom=<BackgroundMusicCustom>' \
  --data-urlencode 'IsBackgroundMusicLoop=false'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — CTA

Imposta CTA primaria

Configura il pulsante di call-to-action primario nel viewer (etichetta, URL, posizione, colore).

Errori comuni: i campi sono IsCTAButton, CTAButtonText, CTAButtonURL (più posizione/colore) — non Text/URL/Position.

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta CTA primaria

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsCTAButtontrue | falsead es. false
CTAButtonText
CTAButtonColor
CTAButtonURLURLI prefissi mailto: / tel: vengono normalizzati automaticamente lato server
CTAButtonTextColor

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-cta-primary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=<CTAButtonText>' \
  --data-urlencode 'CTAButtonColor=<CTAButtonColor>' \
  --data-urlencode 'CTAButtonURL=<CTAButtonURL>' \
  --data-urlencode 'CTAButtonTextColor=<CTAButtonTextColor>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta CTA secondaria

Configura il pulsante di call-to-action secondario nel viewer.

Errori comuni: il pulsante secondario usa i campi con suffisso 2IsCTAButton2, CTAButtonText2, CTAButtonURL2.

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta CTA secondaria

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsCTAButton2true | falsead es. false
CTAButtonText2
CTAButtonColor2
CTAButtonTextColor2
CTAButtonURL2URL

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-cta-secondary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=<CTAButtonText2>' \
  --data-urlencode 'CTAButtonColor2=<CTAButtonColor2>' \
  --data-urlencode 'CTAButtonTextColor2=<CTAButtonTextColor2>' \
  --data-urlencode 'CTAButtonURL2=<CTAButtonURL2>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta regole di anteprima della CTA

Configura quando la call-to-action viene mostrata ai lettori — ad es. dopo N pagine o N secondi (le regole del gate di anteprima).

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta regole di anteprima della CTA

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsCTAHiddenInPreviewtrue | falsead es. false

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-cta-preview-rules/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — controllo degli accessi

Imposta accesso con password

Attiva/disattiva la protezione con password per il flipbook e imposta la password di accesso.

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta accesso con password

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsPasswordProtectedtrue | falsead es. false
Password
PwdTitle
PwdPlaceholder
PwdButton

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-password-access/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-password-access/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'PwdTitle=<PwdTitle>' \
  --data-urlencode 'PwdPlaceholder=<PwdPlaceholder>' \
  --data-urlencode 'PwdButton=<PwdButton>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta indicizzazione

Controlla l'indicizzazione del flipbook ospitato da parte dei motori di ricerca. IsNoIndex=true aggiunge un robots noindex così la pagina non viene indicizzata.

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta indicizzazione

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsNoIndextrue | falsead es. false

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-indexing/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-indexing/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNoIndex=false'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta lista email consentite

Limita l'accesso al viewer a un elenco di indirizzi email consentiti (visualizzazione protetta).

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta lista email consentite

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

EmailsAllowedElenco delimitato di email consentite

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-email-allow-list/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=<EmailsAllowed>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — acquisizione lead

Imposta acquisizione lead (base)

Abilita e configura il modulo di base per l'acquisizione dei lead (il gate che raccoglie i dati del lettore prima della lettura).

Errori comuni: il flag di abilitazione è IsLeadCapture, non IsEnabled.

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisizione lead (base)

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsLeadCapturetrue | falsead es. false
LeadCaptureTitle
IsLeadAllowSkiptrue | falsead es. false
LeadSkipText
LeadFormAfterPagesnumberad es. 0
LeadAfterPagesnumberad es. 0

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-lead-capture/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=false' \
  --data-urlencode 'LeadCaptureTitle=<LeadCaptureTitle>' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=<LeadSkipText>' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta campi lead

Attiva ciascun campo standard di acquisizione lead (nome, email, telefono, azienda, ecc.) e ne definisce l'obbligatorietà.

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisizione lead (base)(attiva l'acquisizione lead)Imposta campi lead

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsLeadEmailtrue | falsead es. true
IsLeadEmailMandatorytrue | falsead es. true
IsLeadNametrue | falsead es. true
IsLeadNameMandatorytrue | falsead es. false
IsLeadPhonetrue | falsead es. false
IsLeadPhoneMandatorytrue | falsead es. false
IsLeadCompanytrue | falsead es. false
IsLeadCompanyMandatorytrue | falsead es. false
IsLeadDatetrue | falsead es. false
IsLeadDateMandatorytrue | falsead es. false
LeadPhoneCountry

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-lead-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadEmail=true' \
  --data-urlencode 'IsLeadEmailMandatory=true' \
  --data-urlencode 'IsLeadName=true' \
  --data-urlencode 'IsLeadNameMandatory=false' \
  --data-urlencode 'IsLeadPhone=false' \
  --data-urlencode 'IsLeadPhoneMandatory=false' \
  --data-urlencode 'IsLeadCompany=false' \
  --data-urlencode 'IsLeadCompanyMandatory=false' \
  --data-urlencode 'IsLeadDate=false' \
  --data-urlencode 'IsLeadDateMandatory=false' \
  --data-urlencode 'LeadPhoneCountry=<LeadPhoneCountry>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta campi lead personalizzati

Definisce campi personalizzati aggiuntivi nel modulo di acquisizione lead, oltre ai campi standard nome/email/telefono.

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisizione lead (base)(attiva l'acquisizione lead)Imposta campi lead personalizzati

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsLeadCustom1true | falsead es. false
IsLeadCustom1Mandatorytrue | falsead es. false
Custom1Label
IsLeadCustom2true | falsead es. false
IsLeadCustom2Mandatorytrue | falsead es. false
Custom2Label

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-lead-custom-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=<Custom1Label>' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label=<Custom2Label>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta etichette lead

Imposta le etichette visualizzate e il testo segnaposto per i campi del modulo di acquisizione lead.

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisizione lead (base)(attiva l'acquisizione lead)Imposta etichette lead

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

LeadEmailemail
LeadName
LeadPhonephone
LeadCompany
LeadDate
LeadButton

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-lead-labels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=<LeadEmail>' \
  --data-urlencode 'LeadName=<LeadName>' \
  --data-urlencode 'LeadPhone=<LeadPhone>' \
  --data-urlencode 'LeadCompany=<LeadCompany>' \
  --data-urlencode 'LeadDate=<LeadDate>' \
  --data-urlencode 'LeadButton=<LeadButton>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta privacy dei lead

Configura il testo e le opzioni di privacy/consenso per l'acquisizione dei lead (ad es. la casella di consenso GDPR).

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisizione lead (base)(attiva l'acquisizione lead)Imposta privacy dei lead

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsLeadPrivacyPolicytrue | falsead es. false
PrivacyPolicyURLURL
PrivacyPolicyText

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-lead-privacy/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-privacy/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadPrivacyPolicy=false' \
  --data-urlencode 'PrivacyPolicyURL=<PrivacyPolicyURL>' \
  --data-urlencode 'PrivacyPolicyText=<PrivacyPolicyText>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta verifica lead

Attiva o disattiva la verifica via email dei lead, richiedendo ai lettori di confermare la propria email prima dell'accesso.

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisizione lead (base)(attiva l'acquisizione lead)Imposta verifica lead

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsVerifyEmailtrue | falsead es. false
IsVerifyMobiletrue | falsead es. false
TwillioAPIKeyLa tua API key di Twilio (il nome del campo mantiene la grafia originale 'Twillio').
EmailVerifyTitleText
EmailVerifyButtonText

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-lead-verification/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-verification/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVerifyEmail=false' \
  --data-urlencode 'IsVerifyMobile=false' \
  --data-urlencode 'TwillioAPIKey=<TwillioAPIKey>' \
  --data-urlencode 'EmailVerifyTitleText=<EmailVerifyTitleText>' \
  --data-urlencode 'EmailVerifyButtonText=<EmailVerifyButtonText>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta webhook lead

Imposta un URL webhook che riceve ogni nuovo lead (salvato come webhook new-lead). Usa test-webhook per verificare che si attivi.

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisizione lead (base)(attiva l'acquisizione lead)Imposta webhook lead

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

WebhookURL_NewLeadURLL'URL del tuo endpoint — riceve un payload JSON per ogni nuovo lead.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-lead-webhook/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=<WebhookURL_NewLead>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Test webhook

Invia un payload di TEST al webhook dei lead configurato per il flipbook, così puoi verificarne il formato di consegna senza un lead reale. Restituisce ERROR 'No lead webhook is configured for this flipbook.' se non ne è impostato nessuno. La struttura del payload corrisponde a un lead reale (chiavi: pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2) ma con valori fittizi (pdf_id:"-1", pdf_name:"Test PDF", ...). Non viene memorizzato alcun lead reale e non viene inviata alcuna email di notifica.

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta webhook lead(occorre configurare prima un webhook)Test webhook

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

POST/api/test-webhook/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Imposta Google Sheets per i lead

Collega l'acquisizione dei lead a un foglio Google — i nuovi lead vengono aggiunti al foglio che indichi (ID del foglio + nome).

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta acquisizione lead (base)(attiva l'acquisizione lead)Imposta Google Sheets per i lead

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

GoogleSheetURLURL
GoogleSheetIDKey
GoogleSheetName

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-lead-google-sheets/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'GoogleSheetURL=<GoogleSheetURL>' \
  --data-urlencode 'GoogleSheetIDKey=<GoogleSheetIDKey>' \
  --data-urlencode 'GoogleSheetName=<GoogleSheetName>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — notifiche e modelli email

Imposta notifiche

Configura quali notifiche email ricevi per questo flipbook (nuovo lead, nuova visualizzazione, nuova vendita).

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta notifiche

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

NotificationsEmailemail
IsSendEmailOnViewtrue | falsead es. false

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-notifications/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-notifications/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=<NotificationsEmail>' \
  --data-urlencode 'IsSendEmailOnView=false'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta modello email — nuovo lead

Imposta l'email inviata in caso di evento di nuovo lead. Invia valori vuoti per ripristinare il modello predefinito NEW_LEAD.

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta modello email — nuovo lead

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

EmailLeadSubject
EmailLeadBody

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-email-template-lead/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=<EmailLeadSubject>' \
  --data-urlencode 'EmailLeadBody=<EmailLeadBody>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta modello email — nuova visualizzazione

Imposta il modello email inviato per una notifica di nuova visualizzazione. Invia vuoto per ripristinare il modello predefinito NEW_VIEW.

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta modello email — nuova visualizzazione

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

EmailViewSubject
EmailViewBody

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-email-template-view/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=<EmailViewSubject>' \
  --data-urlencode 'EmailViewBody=<EmailViewBody>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta modello email — nuova vendita

Imposta il modello email inviato per una notifica di nuova vendita. Invia vuoto per ripristinare il modello predefinito NEW_SALE.

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta modello email — nuova vendita

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

EmailSaleSubject
EmailSaleBody

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-email-template-sale/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=<EmailSaleSubject>' \
  --data-urlencode 'EmailSaleBody=<EmailSaleBody>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — vendite

Imposta impostazioni di vendita

Configura la vendita del flipbook (prezzo, valuta, opzioni). Abilitare la modalità di vendita attiva automaticamente la verifica via email e rende obbligatoria l'email del lead.

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Elenca valute(scegli SaleCurr)Imposta impostazioni di vendita

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsForSaletrue | falsead es. false
SaleCurrDa /api/list-currencies
SaleAmountnumberad es. 0

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-sale-settings/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-settings/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsForSale=false' \
  --data-urlencode 'SaleCurr=USD' \
  --data-urlencode 'SaleAmount=0'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta testo della pagina di vendita

Imposta il testo di marketing mostrato nella pagina di vendita / checkout del flipbook.

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta impostazioni di vendita(abilita la vendita)Imposta testo della pagina di vendita

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

SalePageTitle
SaleAccessPageTitle
SalePurchaseButtonText
SaleButtonText
SaleAccessButtonText
SaleButtonColor

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-sale-page-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-page-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SalePageTitle=<SalePageTitle>' \
  --data-urlencode 'SaleAccessPageTitle=<SaleAccessPageTitle>' \
  --data-urlencode 'SalePurchaseButtonText=<SalePurchaseButtonText>' \
  --data-urlencode 'SaleButtonText=<SaleButtonText>' \
  --data-urlencode 'SaleAccessButtonText=<SaleAccessButtonText>' \
  --data-urlencode 'SaleButtonColor=<SaleButtonColor>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta gateway di vendita

Seleziona e configura il gateway di pagamento usato per la vendita di questo flipbook.

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta impostazioni di vendita(abilita la vendita)Imposta gateway di vendita

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

SaleGatewayName
SaleGatewayKey
SaleGatewaySecret

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-sale-gateway/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-gateway/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SaleGatewayName=<SaleGatewayName>' \
  --data-urlencode 'SaleGatewayKey=<SaleGatewayKey>' \
  --data-urlencode 'SaleGatewaySecret=<SaleGatewaySecret>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — approvazione

Imposta pulsante di approvazione

Aggiunge un pulsante di richiesta di approvazione al viewer. Abilitarlo avvia il flusso di richiesta di approvazione.

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(DocType=document — solo elementi Document)Imposta pulsante di approvazione

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsApprovalButtontrue | falsead es. false
ApprovalButtonText
ApprovalButtonColor
ApprovalButtonTextColor

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-approval-button/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-button/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=false' \
  --data-urlencode 'ApprovalButtonText=<ApprovalButtonText>' \
  --data-urlencode 'ApprovalButtonColor=<ApprovalButtonColor>' \
  --data-urlencode 'ApprovalButtonTextColor=<ApprovalButtonTextColor>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta modelli email di approvazione

Imposta i modelli email usati dal flusso di approvazione. I valori vuoti recuperano i modelli predefiniti.

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(DocType=document — solo elementi Document)Imposta modelli email di approvazione

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

EmailApproveRequestSubject
EmailApproveRequestBody
EmailApproveRemindSubject
EmailApproveRemindBody
EmailApproveSubmitSubject
EmailApproveSubmitBody

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-approval-email-templates/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=<EmailApproveRequestSubject>' \
  --data-urlencode 'EmailApproveRequestBody=<EmailApproveRequestBody>' \
  --data-urlencode 'EmailApproveRemindSubject=<EmailApproveRemindSubject>' \
  --data-urlencode 'EmailApproveRemindBody=<EmailApproveRemindBody>' \
  --data-urlencode 'EmailApproveSubmitSubject=<EmailApproveSubmitSubject>' \
  --data-urlencode 'EmailApproveSubmitBody=<EmailApproveSubmitBody>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — condivisione

Imposta interruttore principale della condivisione

Interruttore principale on/off per i pulsanti di condivisione nel viewer.

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta interruttore principale della condivisione

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsShareButtonstrue | falsead es. false

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-share-master/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-master/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareButtons=false'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta canali di condivisione

Attiva singolarmente ogni canale di condivisione social (Facebook, X, LinkedIn, WhatsApp, email, ecc.) nel menu di condivisione del viewer.

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta canali di condivisione

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsShareFacebooktrue | falsead es. true
IsShareTwittertrue | falsead es. true
IsShareWhatsApptrue | falsead es. true
IsShareTelegramtrue | falsead es. false
IsShareLinkedIntrue | falsead es. true
IsSharePinteresttrue | falsead es. false
IsShareReddittrue | falsead es. false
IsShareTumblrtrue | falsead es. false
IsShareMessengertrue | falsead es. false
IsShareEmailtrue | falsead es. true
IsShareLinetrue | falsead es. false
IsShareWeChattrue | falsead es. false
IsShareInstagramtrue | falsead es. false
IsShareFlipboardtrue | falsead es. false
IsShareGeneraltrue | falsead es. true

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-share-channels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-channels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareFacebook=true' \
  --data-urlencode 'IsShareTwitter=true' \
  --data-urlencode 'IsShareWhatsApp=true' \
  --data-urlencode 'IsShareTelegram=false' \
  --data-urlencode 'IsShareLinkedIn=true' \
  --data-urlencode 'IsSharePinterest=false' \
  --data-urlencode 'IsShareReddit=false' \
  --data-urlencode 'IsShareTumblr=false' \
  --data-urlencode 'IsShareMessenger=false' \
  --data-urlencode 'IsShareEmail=true' \
  --data-urlencode 'IsShareLine=false' \
  --data-urlencode 'IsShareWeChat=false' \
  --data-urlencode 'IsShareInstagram=false' \
  --data-urlencode 'IsShareFlipboard=false' \
  --data-urlencode 'IsShareGeneral=true'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Sezioni — tracciamento e AI

Imposta tracciamento analytics

Aggiunge i tuoi ID di tracciamento analytics (ad es. Google Analytics, GTM, Facebook Pixel) al flipbook ospitato.

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta tracciamento analytics

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

FacebookAnalyticsCode
GoogleAnalyticsCode
GoogleTagManager

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-analytics-tracking/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=<FacebookAnalyticsCode>' \
  --data-urlencode 'GoogleAnalyticsCode=<GoogleAnalyticsCode>' \
  --data-urlencode 'GoogleTagManager=<GoogleTagManager>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta provider AI

Configura il provider AI usato per le funzionalità di AI — il nome del provider e la sua API key.

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta provider AI

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

AIProvider
AIKey

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-ai-provider/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=<AIProvider>' \
  --data-urlencode 'AIKey=<AIKey>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta assistente virtuale

Configura le impostazioni di base dell'assistente virtuale (chat/aiuto) all'interno del viewer.

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta assistente virtuale

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

IsVAtrue | falsead es. false
VAButtonText
VAButtonColor
VAButtonTextColor
VATextPrompt / istruzioni per l'assistente
VAEmbeddingsBlob di embedding (stringa)

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-virtual-assistant/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=<VAButtonText>' \
  --data-urlencode 'VAButtonColor=<VAButtonColor>' \
  --data-urlencode 'VAButtonTextColor=<VAButtonTextColor>' \
  --data-urlencode 'VAText=<VAText>' \
  --data-urlencode 'VAEmbeddings=<VAEmbeddings>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo

Imposta testo di stato dell'assistente virtuale

Imposta il testo di stato/saluto mostrato dall'assistente virtuale all'interno del viewer.

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}
PrerequisitiChi sono(una API key valida)Crea da file(ottieni un flipbookId)Imposta testo di stato dell'assistente virtuale

Parametri di percorso

flipbookIdnumberID numerico del flipbook/documento — restituito da create-by-file / create-by-url (come ID) o da list.

Parametri del corpo

VAButtonStatus1Etichetta dello stato di ascolto
VAButtonStatus2Etichetta dello stato di registrazione
VAButtonStatus3Etichetta dello stato di elaborazione
VAButtonStatus4Etichetta dello stato di riproduzione vocale

Risposte di errore

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una chiave mancante/non valida viene respinta con HTTP 401 (una pagina HTML, niente JSON). Ogni altro errore restituisce HTTP 200 con { "Result": "ERROR", "Message": … } — quindi ramifica sempre in base a Result, non solo allo stato HTTP.

PUT/api/set-virtual-assistant-status-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=<VAButtonStatus1>' \
  --data-urlencode 'VAButtonStatus2=<VAButtonStatus2>' \
  --data-urlencode 'VAButtonStatus3=<VAButtonStatus3>' \
  --data-urlencode 'VAButtonStatus4=<VAButtonStatus4>'
Esempio di risposta200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Incolla la tua API key in “La tua API key” in alto — poi compila i campi qui sotto e invia.

Parametri di percorso — necessari per identificare l'elemento

Parametri del corpo