Référence de l'API FlipLink

Profil

Qui suis-je

Renvoie le compte propriétaire de la clé d'API — identifiants user/vendor, nom, e-mail, marque, URL de l'application et la taille d'envoi maximale du forfait (MaxFileSizeMB).

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

Prérequis — aucun. C'est l'appel racine : il authentifie ta clé d'API, le prérequis de tous les autres endpoints.

Aucun paramètre.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer les détails de l'abonnement Récupérer le profil

GET/api/whoami

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

Exemple de réponse200 OK

{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Récupérer le profil

Renvoie le profil du compte associé à la clé d'API — nom affiché, téléphone et URL de l'image de profil.

GEThttps://go.fliplink.me/api/get-profile

PrérequisQui suis-je(une clé d'API valide)→Récupérer le profil

Aucun paramètre.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le profil (partiel)Qui suis-je

GET/api/get-profile

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

Exemple de réponse200 OK

{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Définir le profil (partiel)

Mise à jour partielle — les champs omis conservent leur valeur actuelle. Au moins un champ est requis.

PUThttps://go.fliplink.me/api/set-profile

PrérequisQui suis-je(une clé d'API valide)→Définir le profil (partiel)

Paramètres du corps

`Name`	par exemple `Mark Stevens`
`Phone`phone	par exemple `+14155550142`
`ProfileImage`URL	par exemple `https://...`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer le profil

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://...'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres du corps

Name

Phonephone

ProfileImageURL

Abonnement et paiements

Récupérer les détails de l'abonnement

Renvoie ton forfait et ton quota actuels — nom du forfait, statut, frais, date de la prochaine facture, taille de fichier maximale, nombre maximal d'éléments/de CNAME et indicateurs de fonctionnalités.

GEThttps://go.fliplink.me/api/get-subscription-details

PrérequisQui suis-je(une clé d'API valide)→Récupérer les détails de l'abonnement

Aucun paramètre.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les paiements Qui suis-je

GET/api/get-subscription-details

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

Exemple de réponse200 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"
  }
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Lister les paiements

Renvoie ton historique de facturation — chaque achat/renouvellement de forfait avec l'identifiant de commande, le montant, le forfait, la date et le nombre d'éléments.

GEThttps://go.fliplink.me/api/list-payments

PrérequisQui suis-je(une clé d'API valide)→Lister les paiements

Aucun paramètre.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer les détails de l'abonnement

GET/api/list-payments

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

Exemple de réponse200 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
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Éléments — Création

Créer à partir d'un fichier

Crée un flipbook (ou un document) à partir d'un PDF envoyé en multipart/form-data. Le fichier est stocké, une miniature est générée et l'enregistrement est créé.

Remarques
- Que tu obtiennes un Flipbook ou un Document dépend de l'en-tête Host de la requête — go.fliplink.me (par défaut) renvoie des Flipbooks, go.doclink.me renvoie des Documents.
- *_Count / *_Max / *_Left reflètent le quota de ton forfait après cette création.
- Utilise l'ID renvoyé pour les appels suivants (set-meta, set-cta-primary, save-as-template, etc.).
- La taille de fichier maximale dépend du forfait (voir MaxFileSizeMB dans who-am-i).

POSThttps://go.fliplink.me/api/create-by-file

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier

Corps (multipart/form-data)

`File`file	—
`Name`	par exemple `My Document`
`Title`	par exemple `My Title`
`DocType`enum	Flipbook ou Document. Sur go.doclink.me, toujours traité comme un Document.L'une des valeurs : `Flipbook`, `Document`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésCréer à partir d'une URL Récupérer un élément Définir les métadonnées

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Corps (form-data)

Filefile

Name

Title

DocTypechoose oneFlipbook ou Document. Sur go.doclink.me, toujours traité comme un Document.

Créer à partir d'une URL

Crée un flipbook (ou un document) à partir de l'URL d'un PDF. Le serveur télécharge FileURL, l'envoie sur S3, génère une miniature et crée l'enregistrement.

Remarques
- Le préfixe du nom de champ Flipbooks_* ou Documents_* dépend de l'en-tête Host de la requête — go.fliplink.me (par défaut) renvoie des Flipbooks, go.doclink.me renvoie des Documents.
- *_Count / *_Max / *_Left reflètent le quota du forfait du compte après cette création.
- L'URL source doit répondre en moins de 60 s — une source lente ou injoignable échoue avec Source URL timed out after 60s. Pour les sources peu fiables, préfère /api/create-by-file.

POSThttps://go.fliplink.me/api/create-by-url

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'une URL

Paramètres du corps

`FileURL`URL	par exemple `https://example.com/document.pdf`
`Name`	par exemple `My Document`
`Title`	par exemple `My Title`
`DocType`enum	par exemple `Flipbook`L'une des valeurs : `Flipbook`, `Document`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésCréer à partir d'un fichier Récupérer un élément Définir les métadonnées

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres du corps

FileURLURL

Name

Title

DocTypechoose one

Éléments — Lecture

Récupérer un élément

Renvoie l'enregistrement complet d'un seul flipbook/document par son ID — chaque colonne stockée : titre, URL, nombres de vues/leads/ventes, dossier et indicateurs de statut. L'enregistrement complet est renvoyé encapsulé dans un objet `Item` comptant environ 190 colonnes ; l'exemple ci-dessous en est un sous-ensemble abrégé et représentatif.

GEThttps://go.fliplink.me/api/get/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Récupérer un élément

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRechercher par URL Récupérer l'URL du PDF Récupérer le lien de partage Lister

GET/api/get/{flipbookId}

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

Exemple de réponse200 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"
  }
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Rechercher par URL

Recherche un flipbook par son URL publique/de partage et renvoie son enregistrement complet (même structure que get).

GEThttps://go.fliplink.me/api/find-by-url

PrérequisQui suis-je(une clé d'API valide)→Rechercher par URL

Paramètres de requête

URLURL URL complète du lecteur, URL de CNAME ou simplement le slug CustomURL brut. Le serveur prend le dernier segment du chemin comme slug.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer un élément Récupérer le lien de partage

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'

Exemple de réponse200 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"
  }
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

URLURLURL complète du lecteur, URL de CNAME ou simplement le slug CustomURL brut. Le serveur prend le dernier segment du chemin comme slug.

Lister

Liste tes flipbooks/documents avec pagination (PageNo/PageSize). Chaque élément contient les identifiants, le titre, les URL, les nombres de vues/leads/ventes, le dossier et les indicateurs de statut.

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

PrérequisQui suis-je(une clé d'API valide)→Lister

Paramètres de requête

`Folder`	—
`SearchText`	—
`PageNo`number	par exemple `1`
`PageSize`number	par exemple `25`
`Offset`number	par exemple `0`
`SortBy`enum	Facultatif. L'une des valeurs : `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Vide = tri par défaut ; les valeurs inconnues reviennent au tri par défaut.L'une des valeurs : `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`
`SortOrder`enum	Facultatif. `ASC` ou `DESC`. Ignoré si SortBy est vide. Les valeurs inconnues reviennent silencieusement au tri par défaut.L'une des valeurs : `ASC`, `DESC`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer un élément Lister les dossiers

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'

Exemple de réponse200 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
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

Folder

SearchText

PageNonumber

PageSizenumber

Offsetnumber

SortBychoose oneFacultatif. L'une des valeurs : `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Vide = tri par défaut ; les valeurs inconnues reviennent au tri par défaut.

SortOrderchoose oneFacultatif. `ASC` ou `DESC`. Ignoré si SortBy est vide. Les valeurs inconnues reviennent silencieusement au tri par défaut.

Récupérer l'URL du PDF

Renvoie l'URL S3 publique du PDF principal de l'élément (version fusionnée si une couverture avant/arrière est ajoutée).

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Récupérer l'URL du PDF

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer un élément Supprimer la page de couverture/dos Définir la page de couverture/dos (fichier)

GET/api/get-pdf/{flipbookId}

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

Exemple de réponse200 OK

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

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Récupérer le lien de partage

Renvoie l'URL publique du lecteur du flipbook (le préfixe de son domaine personnalisé/hôte plus le slug de partage du flipbook).

Réponse : { "Result": "OK", "URL": "https://go.fliplink.me/view/<guid>" }.

GEThttps://go.fliplink.me/api/get-share-link/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Récupérer le lien de partage

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer un élément Définir l'URL personnalisée

GET/api/get-share-link/{flipbookId}

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

Exemple de réponse200 OK

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

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Éléments — Modification

Dupliquer

Crée une ou plusieurs copies côté serveur d'un flipbook — chaque copie reçoit son propre nouvel ID et son URL de partage. Tu peux en dupliquer jusqu'à 20 à la fois (Count).

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Dupliquer

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

Countnumber 1–500 (borné côté serveur)

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer un élément Créer à partir d'un fichier

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

Countnumber1–500 (borné côté serveur)

Remplacer le PDF (fichier)

Envoi en multipart. Refusionne automatiquement avec la couverture avant/arrière existante si elle est attachée.

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Remplacer le PDF (fichier)

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Corps (multipart/form-data)

Filefile —

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRemplacer le PDF (URL)Définir la page de couverture/dos (fichier)Supprimer la page de couverture/dos Récupérer l'URL du PDF

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Corps (form-data)

Filefile

Remplacer le PDF (URL)

Remplace le PDF d'un flipbook existant par un PDF que le serveur télécharge depuis une URL que tu fournis. Le flipbook conserve son ID, ses réglages et son lien de partage.

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Remplacer le PDF (URL)

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

FileURL par exemple https://example.com/new.pdf

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRemplacer le PDF (fichier)Définir la page de couverture/dos (URL)Récupérer l'URL du PDF

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

FileURL

Enregistrer comme modèle (bascule)

Marque le flipbook comme modèle réutilisable (Status=true) ou le retire des modèles (Status=false). Les modèles apparaissent dans list-templates et peuvent servir de base à de nouveaux flipbooks.

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Enregistrer comme modèle (bascule)

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

Statustrue | false true/false. true par défaut si omis.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les modèles Créer à partir d'un fichier

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Saved as template"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

Statustrue / falsetrue/false. true par défaut si omis.

Affecter à un dossier

Déplace le flipbook dans un dossier pour l'organiser. Les dossiers sont créés à la demande — affecte le flipbook à un nom de dossier qui n'existe pas encore et il est créé automatiquement (il n'y a pas d'appel « create folder » distinct). Envoie un champ Folder vide pour retirer le flipbook de son dossier. Un dossier n'existe que tant qu'au moins un flipbook s'y trouve : déplacer le dernier flipbook hors d'un dossier le fait disparaître de list-folders. Les noms de dossier peuvent contenir / (par exemple Marketing/Q2).

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Affecter à un dossier

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

Folder Nom du dossier où déplacer le flipbook — créé s'il n'existe pas (ou réutilise un nom de list-folders). Envoie une valeur vide pour annuler l'affectation.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les dossiers Définir un membre de l'équipe (créer ou mettre à jour)

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

FolderNom du dossier où déplacer le flipbook — créé s'il n'existe pas (ou réutilise un nom de list-folders). Envoie une valeur vide pour annuler l'affectation.

Définir la page de couverture/dos (fichier)

L'un des deux ou les deux (couverture/dos) sont facultatifs — au moins un est requis. Refusionne avec le PDF principal existant.

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la page de couverture/dos (fichier)

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Corps (multipart/form-data)

`Front`file	—
`Back`file	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la page de couverture/dos (URL)Supprimer la page de couverture/dos Remplacer le PDF (fichier)Récupérer l'URL du PDF

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'

Exemple de réponse200 OK

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

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Corps (form-data)

Frontfile

Backfile

Définir la page de couverture/dos (URL)

Variante par URL de set-front-back-page — attache les pages de couverture/dos depuis l'URL d'un PDF distant au lieu d'un fichier envoyé.

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la page de couverture/dos (URL)

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`Front`URL	par exemple `https://example.com/front.pdf`
`Back`URL	par exemple `https://example.com/back.pdf`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la page de couverture/dos (fichier)Supprimer la page de couverture/dos Récupérer l'URL du PDF

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'

Exemple de réponse200 OK

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

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

FrontURL

BackURL

Supprimer la page de couverture/dos

Supprime l'habillage couverture/dos et restaure FilePDF au PDF principal sans habillage (MiddlePDF). Idempotent — un flipbook sans habillage renvoie OK sans rien modifier. Renvoie { Result, Message, URL (URL S3 du PDF principal) }. Les anciens objets S3 fusionnés/de couverture/de dos ne sont pas supprimés.

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Supprimer la page de couverture/dos

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la page de couverture/dos (fichier)Récupérer l'URL du PDF

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Définir/supprimer l'expiration

Définit ou supprime l'expiration automatique d'un flipbook. Envoie Days + Hours sous forme d'entiers ; Days=-1, Hours=0 supprime entièrement l'expiration.

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir/supprimer l'expiration

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`Days`number	Utilise -1 pour supprimer l'expiration
`Hours`number	Facultatif, 0 par défaut

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir l'épinglage (bascule)Définir la publication (publier / dépublier)

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

DaysnumberUtilise -1 pour supprimer l'expiration

HoursnumberFacultatif, 0 par défaut

Définir l'épinglage (bascule)

Épingle ou désépingle le flipbook (l'état favori) pour qu'il remonte en haut de ton tableau de bord.

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'épinglage (bascule)

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister

PUT/api/set-pin/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Éléments — Suppression

Supprimer

Supprime définitivement l'enregistrement du flipbook en base de données. Remarque : les fichiers S3 sous-jacents ne sont PAS supprimés automatiquement.

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Supprimer

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésSupprimer des leads (en masse)Lister

DELETE/api/delete/{flipbookId}

curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

CNAME (domaines personnalisés)

Ajouter un CNAME

Associe un domaine personnalisé (CNAME) déjà activé à un flipbook. Le domaine doit d'abord être ajouté et vérifié via le tableau de bord web (qui provisionne le DNS + le SSL) ; cet endpoint ne fait qu'enregistrer l'association — il ne vérifie pas le DNS et n'émet pas de certificat.

Conditions préalables :
- Le CNAME doit déjà exister sur ton compte (ajouté via le tableau de bord). Sinon : Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- Il doit respecter la limite de CNAME de ton forfait.

Paramètres :
- CNAME (requis) — nom d'hôte complet, par exemple docs.example.com
- IsCloudflare (facultatif, 0 par défaut).

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Ajouter un CNAME

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`CNAME`	par exemple `docs.example.com`
`IsCloudflare`true \| false	Facultatif. 0 (par défaut) ou 1. Indique 1 si ton DNS passe par le proxy de Cloudflare.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les CNAME Supprimer un CNAME Définir l'URL personnalisée

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

CNAME

IsCloudflaretrue / falseFacultatif. 0 (par défaut) ou 1. Indique 1 si ton DNS passe par le proxy de Cloudflare.

Lister les CNAME

Tous les CNAME personnalisés de l'appelant. Chaque élément : { CNAME, Documents (nombre de flipbooks actifs), FlipbookIDs ([...] des ID des flipbooks actifs liés à ce CNAME) }.

GEThttps://go.fliplink.me/api/list-cnames

PrérequisQui suis-je(une clé d'API valide)→Lister les CNAME

Aucun paramètre.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésAjouter un CNAME Supprimer un CNAME

GET/api/list-cnames

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

Exemple de réponse200 OK

{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Supprimer un CNAME

Retire l'association d'un domaine personnalisé (CNAME) de l'un ou de tous tes flipbooks. Deux modes :

En masse (par défaut) : passe CNAME=<host> et laisse FlipbookID vide — retire ce CNAME de tous les flipbooks que tu possèdes.
Par flipbook : passe FlipbookID=<id> — le CNAME est récupéré depuis ce flipbook. À utiliser pour une action « Supprimer le CNAME » par ligne.

Réponse (par flipbook) : { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
Réponse (en masse) : { "Result": "OK", "Message": "CNAME removed successfully" }
Les deux manquants : { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

Remarque : passe le CNAME en paramètre de requête (et non en segment d'URL) pour éviter les problèmes liés aux points dans le nom d'hôte.

DELETEhttps://go.fliplink.me/api/delete-cname

PrérequisQui suis-je(une clé d'API valide)→Lister les CNAME(trouve le CNAME / FlipbookID)→Supprimer un CNAME

Paramètres de requête

`CNAME`	Requis en mode EN MASSE (retire le CNAME de tous les flipbooks que tu possèdes). Ignoré lorsque FlipbookID > 0 — le CNAME est alors pris dans ce flipbook.
`FlipbookID`number	Facultatif. Passe un ID de flipbook > 0 pour retirer le CNAME de CE flipbook uniquement (mode par flipbook). Laisse vide/omets/0 pour le mode en masse (retrait sur tous).

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésAjouter un CNAME Lister les CNAME

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

CNAMERequis en mode EN MASSE (retire le CNAME de tous les flipbooks que tu possèdes). Ignoré lorsque FlipbookID > 0 — le CNAME est alors pris dans ce flipbook.

FlipbookIDnumberFacultatif. Passe un ID de flipbook > 0 pour retirer le CNAME de CE flipbook uniquement (mode par flipbook). Laisse vide/omets/0 pour le mode en masse (retrait sur tous).

Dossiers

Lister les dossiers

Liste tes dossiers, chacun sous la forme { Folder (nom), URL (un GUID de dossier) }. Les dossiers sont dérivés des affectations de flipbooks (créées via assign-to-folder), donc un dossier vide n'est pas listé. Les noms de dossier alimentent assign-to-folder (pour placer un flipbook) et set-team-member (pour restreindre l'accès d'un membre d'équipe).

GEThttps://go.fliplink.me/api/list-folders

PrérequisQui suis-je(une clé d'API valide)→Lister les dossiers

Aucun paramètre.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésAffecter à un dossier Définir un membre de l'équipe (créer ou mettre à jour)

GET/api/list-folders

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

Exemple de réponse200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Membres de l'équipe

Lister les membres de l'équipe

Liste les membres de l'équipe (utilisateurs vendor) de ton compte avec leurs détails d'accès, y compris les dossiers affectés à chaque membre. Les mots de passe ne sont jamais renvoyés. Filtre avec IsActive.

GEThttps://go.fliplink.me/api/list-team-members

PrérequisQui suis-je(une clé d'API valide)→Lister les membres de l'équipe

Paramètres de requête

IsActivetrue | false 1=actifs (par défaut), 0=inactifs

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir un membre de l'équipe (créer ou mettre à jour)Récupérer un membre de l'équipe Définir un membre de l'équipe comme actif Supprimer un membre de l'équipe

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

IsActivetrue / false1=actifs (par défaut), 0=inactifs

Récupérer un membre de l'équipe

Renvoie un seul membre de l'équipe par son ID de membre (l'ID de list-team-members) — nom, e-mail, statut actif et les dossiers auxquels le membre est affecté. Un membre de l'équipe est limité aux dossiers définis via set-team-member (le champ Folders), donc il ne peut accéder qu'aux flipbooks situés dans ces dossiers. Les mots de passe ne sont jamais renvoyés. Le memberId est l'ID du membre de l'équipe (de List Team Members) — et non un ID de flipbook ; passer un ID de flipbook renvoie « Team member not found ». Le membre est renvoyé encapsulé dans un objet Item ; Folders est une liste, séparée par des virgules, des dossiers auxquels il peut accéder (vide = aucune restriction de dossier).

GEThttps://go.fliplink.me/api/get-team-member/{memberId}

PrérequisQui suis-je(une clé d'API valide)→Définir un membre de l'équipe (créer ou mettre à jour)(crée d'abord un membre)→Récupérer un membre de l'équipe

Paramètres de chemin

memberIdnumber ID du membre de l'équipe (de list-team-members). PAS un ID de flipbook.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les membres de l'équipe Définir un membre de l'équipe (créer ou mettre à jour)Lister les dossiers

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

memberIdrequirednumberID du membre de l'équipe (de list-team-members). PAS un ID de flipbook.

Définir un membre de l'équipe (créer ou mettre à jour)

Crée un nouveau membre de l'équipe (utilisateur vendor) ou met à jour un membre existant — pour contrôler qui peut accéder à ton compte et, via le champ Folders, les dossiers auxquels il est limité (un membre ne voit que les flipbooks situés dans ses dossiers affectés). Une entrée de journal d'audit est écrite en cas de succès.

Erreurs courantes : le nom du membre est un unique champ Name — il n'y a pas de FirstName/LastName. Folders est une liste séparée par des virgules de noms de dossiers issus de List Folders (par exemple Marketing,Sales) ; laisse-la vide pour aucune restriction de dossier. La création d'un membre renvoie { Result:"OK", Message:"Team member created" } (le chemin de mise à jour — lorsque ID est fourni — renvoie « Updated successfully »). L'e-mail du membre ne doit pas déjà appartenir à un utilisateur FlipLink, et les e-mails avec alias + sont refusés.

POSThttps://go.fliplink.me/api/set-team-member

PrérequisQui suis-je(une clé d'API valide)→Lister les dossiers(noms pour la portée Folders)→Définir un membre de l'équipe (créer ou mettre à jour)

Paramètres du corps

`Name`	par exemple `Jane`
`Email`email	par exemple `jane@example.com`
`ID`number	Omets ou -1 pour créer. >0 pour mettre à jour.
`Password`	En clair ; chiffré côté serveur. Vide lors d'une mise à jour conserve la valeur existante.
`ProfileImage`URL	—
`Folders`	Dossiers auxquels ce membre est limité — une liste délimitée de noms de dossiers (de list-folders). Le membre ne peut accéder qu'aux flipbooks situés dans ces dossiers.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les membres de l'équipe Récupérer un membre de l'équipe Définir un membre de l'équipe comme actif Supprimer un membre de l'équipe Lister les dossiers

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Team member created"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres du corps

Name

Emailemail

IDnumberOmets ou -1 pour créer. >0 pour mettre à jour.

PasswordEn clair ; chiffré côté serveur. Vide lors d'une mise à jour conserve la valeur existante.

ProfileImageURL

FoldersDossiers auxquels ce membre est limité — une liste délimitée de noms de dossiers (de list-folders). Le membre ne peut accéder qu'aux flipbooks situés dans ces dossiers.

Définir un membre de l'équipe comme actif

Active ou désactive un membre de l'équipe, déterminant s'il peut se connecter et accéder au compte.

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}

PrérequisQui suis-je(une clé d'API valide)→Définir un membre de l'équipe (créer ou mettre à jour)(crée d'abord un membre)→Définir un membre de l'équipe comme actif

Paramètres de chemin

memberIdnumber ID du membre de l'équipe (de list-team-members). PAS un ID de flipbook.

Paramètres du corps

IsActivetrue | false par exemple true

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les membres de l'équipe Définir un membre de l'équipe (créer ou mettre à jour)Supprimer un membre de l'équipe

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

memberIdrequirednumberID du membre de l'équipe (de list-team-members). PAS un ID de flipbook.

Paramètres du corps

IsActivetrue / false

Supprimer un membre de l'équipe

Suppression logique (désactivation). Les membres de l'équipe ne sont jamais supprimés physiquement — cela désactive le membre (un alias REST de set-team-member-active avec IsActive=false). Leur historique de paiement et leurs références d'audit restent intacts, et ils peuvent être réactivés plus tard via PUT /api/set-team-member-active (IsActive=true).

Réponse : { "Result": "OK", "Message": "Team member deactivated" }.

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}

PrérequisQui suis-je(une clé d'API valide)→Définir un membre de l'équipe (créer ou mettre à jour)(crée d'abord un membre)→Supprimer un membre de l'équipe

Paramètres de chemin

memberIdnumber ID du membre de l'équipe (de list-team-members). PAS un ID de flipbook.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir un membre de l'équipe comme actif Lister les membres de l'équipe

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'

Exemple de réponse200 OK

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

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

memberIdrequirednumberID du membre de l'équipe (de list-team-members). PAS un ID de flipbook.

Leads et ventes

Lister les leads

Liste les soumissions de capture de leads collectées par tes flipbooks. Renvoie Items[] plus un schéma dynamique Columns[] (pour afficher un tableau) et TotalRecordCount. Prend en charge la pagination et l'export CSV via IsDownload.

GEThttps://go.fliplink.me/api/list-leads

PrérequisQui suis-je(une clé d'API valide)→Lister les leads

Paramètres de requête

`ItemIDs`	ID de flipbooks séparés par des virgules OU des barres verticales (vide = tous)
`SearchText`	—
`PageNo`number	par exemple `1`
`Offset`number	par exemple `0`
`IsDownload`true \| false	par exemple `true`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésSupprimer un lead Supprimer des leads (en masse)Définir la capture de leads (base)

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'

Exemple de réponse200 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
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

ItemIDsID de flipbooks séparés par des virgules OU des barres verticales (vide = tous)

SearchText

PageNonumber

Offsetnumber

IsDownloadtrue / false

Lister les ventes

Liste les enregistrements de vente/achat de tes flipbooks (e-mail de l'acheteur, flipbook, montant, date) plus les définitions de colonnes du tableau des ventes. Prend en charge la pagination et l'export CSV via IsDownload.

GEThttps://go.fliplink.me/api/list-sales

PrérequisQui suis-je(une clé d'API valide)→Lister les ventes

Paramètres de requête

`ItemIDs`	—
`SearchText`	—
`PageNo`number	par exemple `1`
`Offset`number	par exemple `0`
`IsDownload`true \| false	par exemple `true`
`IsAbandoned`true \| false	true → renvoie les ventes de panier abandonné au lieu des ventes finalisées

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les réglages de vente Définir l'achat d'un flipbook

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'

Exemple de réponse200 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
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

ItemIDs

SearchText

PageNonumber

Offsetnumber

IsDownloadtrue / false

IsAbandonedtrue / falsetrue → renvoie les ventes de panier abandonné au lieu des ventes finalisées

Supprimer un lead

Supprime un seul lead capturé par son ID. Le segment de chemin est le leadId ; passe aussi l'Email du lead et son FlipbookID en paramètres de requête.

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}

PrérequisQui suis-je(une clé d'API valide)→Lister les leads(récupère un ID de lead)→Supprimer un lead

Paramètres de chemin

leadIdnumber L'ID du lead (le LeadID de list-leads).

Paramètres de requête

`Email`email	par exemple `foo@example.com`
`FlipbookID`number	par exemple `{{flipbookId}}`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les leads Supprimer des leads (en masse)

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

leadIdrequirednumberL'ID du lead (le LeadID de list-leads).

Paramètres de requête

Emailemail

FlipbookIDnumber

Supprimer des leads (en masse)

Supprime des leads en masse selon un filtre. Au moins UN des paramètres FlipbookID/Email/DateFrom/DateTo est REQUIS — un appel sans filtre est refusé (il n'y a pas de « tout supprimer »). Toujours limité au vendor. Renvoie { Result, Deleted (nombre) }. Nettoie aussi les lignes enfants (journal des vues / clics sur CTA / journal d'export de feuille).

DELETEhttps://go.fliplink.me/api/delete-leads

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(restreins par FlipbookID)→Supprimer des leads (en masse)

Paramètres de requête

`FlipbookID`number	Facultatif. Supprime uniquement les leads de ce flipbook.
`Email`email	Facultatif. Correspondance EXACTE de l'e-mail.
`DateFrom`	Facultatif. Supprime les leads capturés à partir de cette date (correspond à Lead.CreatedOn). Toute date analysable, par exemple 2026-01-01 ou 2026-01-01T00:00:00Z.
`DateTo`	Facultatif. Supprime les leads capturés jusqu'à cette date incluse.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les leads Supprimer un lead

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

FlipbookIDnumberFacultatif. Supprime uniquement les leads de ce flipbook.

EmailemailFacultatif. Correspondance EXACTE de l'e-mail.

DateFromFacultatif. Supprime les leads capturés à partir de cette date (correspond à Lead.CreatedOn). Toute date analysable, par exemple 2026-01-01 ou 2026-01-01T00:00:00Z.

DateToFacultatif. Supprime les leads capturés jusqu'à cette date incluse.

Définir l'achat d'un flipbook

Enregistre une vente (un achat) finalisée d'un flipbook — utilise-le pour consigner des achats effectués via ton propre flux de paiement, sans passer par le paiement Stripe de FlipLink.

Paramètre de chemin : {flipbookId} — le flipbook marqué comme acheté.

Corps (urlencoded) :
- Email — e-mail de l'acheteur (requis)
- PaymentRef — la référence de ta passerelle de paiement, par exemple un identifiant Stripe PaymentIntent (requis)

Réponse (succès) : { "Result": "OK", "Message": "Purchase recorded successfully" }
Réponse (erreur) : { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

Erreurs courantes : envoie PaymentRef ; n'envoie PAS Amount/Currency — ces valeurs sont dérivées côté serveur à partir de ta référence de paiement.

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'achat d'un flipbook

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`Email`email	Adresse e-mail de l'acheteur (requis).
`PaymentRef`	Référence du payment-intent de la passerelle (requis). Pour Stripe, il s'agit de l'identifiant PaymentIntent (`pi_...`).

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les réglages de vente Définir la passerelle de paiement Lister les ventes

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

EmailemailAdresse e-mail de l'acheteur (requis).

PaymentRefRéférence du payment-intent de la passerelle (requis). Pour Stripe, il s'agit de l'identifiant PaymentIntent (`pi_...`).

Recherches

Lister les modèles

Liste les modèles de flipbook réutilisables enregistrés sur ton compte. Filtre par DocType (0 = tous). Utilise l'ID d'un modèle avec save-as-template / les flux de création.

GEThttps://go.fliplink.me/api/list-templates

PrérequisQui suis-je(une clé d'API valide)→Lister les modèles

Paramètres de requête

DocTypenumber 0 = Flipbook (par défaut), 1 = Document

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésEnregistrer comme modèle (bascule)Créer à partir d'un fichier

GET/api/list-templates

curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

DocTypenumber0 = Flipbook (par défaut), 1 = Document

Lister les habillages

Liste les habillages/thèmes de lecteur disponibles ; chaque ligne porte l'URL de l'arrière-plan fourni avec l'habillage. Utilise le nom d'un habillage avec set-skin.

GEThttps://go.fliplink.me/api/list-skins

PrérequisQui suis-je(une clé d'API valide)→Lister les habillages

Paramètres de requête

Typetrue | false 0=habillages de Flipbook, 1=habillages de Document

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir l'habillage

GET/api/list-skins

curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemple de réponse200 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"
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de requête

Typetrue / false0=habillages de Flipbook, 1=habillages de Document

Lister les devises

Liste les devises disponibles pour vendre un flipbook (pour les réglages de vente/de paiement).

GEThttps://go.fliplink.me/api/list-currencies

PrérequisQui suis-je(une clé d'API valide)→Lister les devises

Aucun paramètre.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les réglages de vente

GET/api/list-currencies

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

Exemple de réponse200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Lister les musiques de fond

Liste les pistes de musique de fond intégrées que tu peux attacher au lecteur d'un flipbook.

GEThttps://go.fliplink.me/api/list-background-music

PrérequisQui suis-je(une clé d'API valide)→Lister les musiques de fond

Aucun paramètre.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la musique de fond

GET/api/list-background-music

curl -X GET 'https://go.fliplink.me/api/list-background-music' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Sections — Image de marque et contenu

Définir les métadonnées

Définit le titre et les métadonnées SEO du flipbook — Title, Description, TitleColor et l'indicateur IsPublished.

Remarque : cela écrase Title/Description/TitleColor. Pour ne changer que l'état de publication, utilise set-published.

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir les métadonnées

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`Title`	—
`Description`	—
`TitleColor`	—
`IsPublished`true \| false	par exemple `false`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la publication (publier / dépublier)

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

Title

Description

TitleColor

IsPublishedtrue / false

Définir la publication (publier / dépublier)

Publie ou dépublie le flipbook — bascule UNIQUEMENT l'indicateur de publication, en laissant Title/Description/TitleColor intacts (contrairement à set-meta). Utilise-le pour (re)publier un flipbook, par exemple un flipbook revenu dépublié de create-by-file.

PUThttps://go.fliplink.me/api/set-published/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la publication (publier / dépublier)

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsPublishedtrue | false true/1 = publier, false/0 = dépublier (requis).

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les métadonnées

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsPublishedtrue / falsetrue/1 = publier, false/0 = dépublier (requis).

Définir l'habillage

Applique un habillage/thème de lecteur au flipbook ; le serveur résout le nom de l'habillage vers son ID.

Erreurs courantes : le champ est SkinName (la chaîne issue de list-skins), pas un ID numérique.

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Lister les habillages(choisis un SkinName)→Définir l'habillage

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

SkinName De /api/list-skins → colonne Name

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les habillages

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

SkinNameDe /api/list-skins → colonne Name

Définir le logo

Définit l'image de logo affichée dans la zone d'en-tête/de marque du lecteur du flipbook.

PUThttps://go.fliplink.me/api/set-logo/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le logo

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`LogoIMG`URL	—
`LogoURL`URL	—
`IsShowLogoMobile`true \| false	par exemple `false`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le favicon Définir l'image d'arrière-plan

PUT/api/set-logo/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-logo/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LogoIMG=<LogoIMG>' \
  --data-urlencode 'LogoURL=<LogoURL>' \
  --data-urlencode 'IsShowLogoMobile=false'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

LogoIMGURL

LogoURLURL

IsShowLogoMobiletrue / false

Définir l'image d'arrière-plan

Définit l'image d'arrière-plan du lecteur à partir d'une URL que tu fournis (il n'y a pas de galerie intégrée).

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'image d'arrière-plan

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

BackgroundIMGURL URL de l'image OU URL d'espace réservé comme https://plchldr.co/i/100x100?text=&bg=HEX

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut 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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

BackgroundIMGURLURL de l'image OU URL d'espace réservé comme https://plchldr.co/i/100x100?text=&bg=HEX

Définir le favicon

Définit le favicon (l'icône de l'onglet du navigateur) utilisé par la page du lecteur hébergé du flipbook.

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le favicon

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

FaviconIMGURL —

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le 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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

FaviconIMGURL

Définir l'apparence des pages

Configure l'apparence des pages du lecteur — arrière-plan, ombre de page, espacement et autres options de présentation. Les valeurs sont stockées telles quelles ; les éléments plus anciens peuvent renvoyer d'autres valeurs (par exemple regular, ou le nombre 1) à la relecture via Get one.

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'apparence des pages

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`PageDepth`enum	flat \| thin \| thickL'une des valeurs : `flat`, `thin`, `thick`
`CoverType`enum	soft \| hardL'une des valeurs : `soft`, `hard`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la navigation de lecture

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

PageDepthchoose oneflat | thin | thick

CoverTypechoose onesoft | hard

Définir le texte de chargement

Définit le texte personnalisé affiché sur l'écran de chargement du lecteur.

Erreurs courantes : le champ est CustomLoadingText, pas LoadingText.

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le texte de chargement

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

CustomLoadingText —

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut 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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

CustomLoadingText

Définir l'URL personnalisée

Définit le slug personnalisé (vanity) de l'URL de partage du flipbook. Il doit être unique ; un slug déjà utilisé renvoie Result:ERROR.

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'URL personnalisée

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

CustomURL —

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésRécupérer le lien de partage Ajouter un CNAME

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

CustomURL

Définir le PDF d'aperçu

Définit le PDF d'aperçu montré aux lecteurs avant la capture de lead / le paiement. Effacé automatiquement si la capture de leads et le mode vente sont tous deux désactivés.

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le PDF d'aperçu

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

PreviewPDFURL —

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le PDF d'image Définir la capture de leads (base)Définir les réglages de vente

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

PreviewPDFURL

Définir le PDF d'image

Définit le PDF d'image uniquement/d'aperçu utilisé pour les miniatures et les aperçus. Envoie une valeur vide pour conserver le PDF d'image existant.

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le PDF d'image

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IMGPdfURL —

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le PDF d'aperçu

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IMGPdfURL

Sections — Lecteur et lecture

Définir les contrôles du lecteur

Affiche ou masque chaque bouton de la barre d'outils du lecteur (téléchargement, impression, partage, plein écran, zoom, miniatures, etc.).

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir les contrôles du lecteur

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsShowControls`true \| false	par exemple `true`
`IsPrint`true \| false	par exemple `false`
`IsDownload`true \| false	par exemple `false`
`IsThumbnails`true \| false	par exemple `true`
`IsSearch`true \| false	par exemple `true`
`IsSound`true \| false	par exemple `true`
`IsFullscreen`true \| false	par exemple `true`
`IsZoom`true \| false	par exemple `true`
`IsNotes`true \| false	par exemple `false`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la navigation de lecture

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsShowControlstrue / false

IsPrinttrue / false

IsDownloadtrue / false

IsThumbnailstrue / false

IsSearchtrue / false

IsSoundtrue / false

IsFullscreentrue / false

IsZoomtrue / false

IsNotestrue / false

Définir la navigation de lecture

Configure la navigation dans le lecteur — miniatures de pages, table des matières et la façon dont les lecteurs passent d'une page à l'autre.

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la navigation de lecture

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsNavFirstLast`true \| false	par exemple `true`
`BookLayout`enum	1=simple, 2=doubleL'une des valeurs : `1`, `2`
`IsRightToLeft`true \| false	par exemple `false`
`ScrollBehaviour`number	Mode de défilement (code numérique)

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les contrôles du lecteur Définir le tournage automatique Définir l'apparence des pages

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsNavFirstLasttrue / false

BookLayoutchoose one1=simple, 2=double

IsRightToLefttrue / false

ScrollBehaviournumberMode de défilement (code numérique)

Définir le tournage automatique

Active ou désactive le tournage automatique des pages dans le lecteur ainsi que son intervalle.

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le tournage automatique

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

AutoFlipInSecsnumber En MILLISECONDES malgré le nom. 0 = désactivé, 3000 = 3 s, 5000 = 5 s, etc.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la navigation de lecture

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

AutoFlipInSecsnumberEn MILLISECONDES malgré le nom. 0 = désactivé, 3000 = 3 s, 5000 = 5 s, etc.

Définir la musique de fond

Définit ou efface la piste de musique de fond qui se joue dans le lecteur. Voir list-background-music pour les pistes disponibles.

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Lister les musiques de fond(choisis une piste)→Définir la musique de fond

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`BackgroundMusic`	Nom de fichier d'une piste prédéfinie (de /api/list-background-music)
`BackgroundMusicCustom`URL	URL d'une musique personnalisée envoyée
`IsBackgroundMusicLoop`true \| false	par exemple `false`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les musiques de fond

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

BackgroundMusicNom de fichier d'une piste prédéfinie (de /api/list-background-music)

BackgroundMusicCustomURLURL d'une musique personnalisée envoyée

IsBackgroundMusicLooptrue / false

Définir la disposition de l'en-tête/du pied de page

Définit le contenu affiché dans les quatre coins (en-tête/pied de page) de l'habillage du lecteur.

PUThttps://go.fliplink.me/api/set-header-footer-layout/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la disposition de l'en-tête/du pied de page

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`TopLeft`	—
`TopRight`	—
`BottomLeft`	—
`BottomRight`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

PUT/api/set-header-footer-layout/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=<TopLeft>' \
  --data-urlencode 'TopRight=<TopRight>' \
  --data-urlencode 'BottomLeft=<BottomLeft>' \
  --data-urlencode 'BottomRight=<BottomRight>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

TopLeft

TopRight

BottomLeft

BottomRight

Sections — CTA

Définir le CTA principal

Configure le bouton d'appel à l'action principal du lecteur (libellé, URL, position, couleur).

Erreurs courantes : les champs sont IsCTAButton, CTAButtonText, CTAButtonURL (plus la position/couleur) — pas Text/URL/Position.

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le CTA principal

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsCTAButton`true \| false	par exemple `false`
`CTAButtonText`	—
`CTAButtonColor`	—
`CTAButtonURL`URL	Les préfixes mailto: / tel: sont normalisés automatiquement côté serveur
`CTAButtonTextColor`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le CTA secondaire Définir les règles d'aperçu du CTA

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsCTAButtontrue / false

CTAButtonText

CTAButtonColor

CTAButtonURLURLLes préfixes mailto: / tel: sont normalisés automatiquement côté serveur

CTAButtonTextColor

Définir le CTA secondaire

Configure le bouton d'appel à l'action secondaire du lecteur.

Erreurs courantes : le bouton secondaire utilise les champs suffixés par 2 — IsCTAButton2, CTAButtonText2, CTAButtonURL2.

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le CTA secondaire

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsCTAButton2`true \| false	par exemple `false`
`CTAButtonText2`	—
`CTAButtonColor2`	—
`CTAButtonTextColor2`	—
`CTAButtonURL2`URL	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le CTA principal Définir les règles d'aperçu du CTA

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsCTAButton2true / false

CTAButtonText2

CTAButtonColor2

CTAButtonTextColor2

CTAButtonURL2URL

Définir les règles d'aperçu du CTA

Configure le moment où l'appel à l'action est montré aux lecteurs — par exemple après N pages ou N secondes (les règles de la barrière d'aperçu).

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir les règles d'aperçu du CTA

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsCTAHiddenInPreviewtrue | false par exemple false

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le CTA principal Définir la capture de leads (base)

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsCTAHiddenInPreviewtrue / false

Sections — Contrôle d'accès

Définir l'accès par mot de passe

Active/désactive la protection par mot de passe du flipbook et définit le mot de passe d'accès.

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'accès par mot de passe

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsPasswordProtected`true \| false	par exemple `false`
`Password`	—
`PwdTitle`	—
`PwdPlaceholder`	—
`PwdButton`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la liste d'e-mails autorisés Définir l'indexation

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsPasswordProtectedtrue / false

Password

PwdTitle

PwdPlaceholder

PwdButton

Définir l'indexation

Contrôle l'indexation par les moteurs de recherche du flipbook hébergé. IsNoIndex=true ajoute un noindex robots pour que la page ne soit pas indexée.

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'indexation

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsNoIndextrue | false par exemple false

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut 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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsNoIndextrue / false

Définir la liste d'e-mails autorisés

Restreint l'accès au lecteur à une liste d'adresses e-mail autorisées (lecture restreinte).

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la liste d'e-mails autorisés

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

EmailsAllowed Liste délimitée d'e-mails autorisés

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir l'accès par mot de passe Définir la vérification des leads

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

EmailsAllowedListe délimitée d'e-mails autorisés

Sections — Capture de leads

Définir la capture de leads (base)

Active et configure le formulaire de capture de leads de base (la barrière qui recueille les coordonnées du lecteur avant la lecture).

Erreurs courantes : l'indicateur d'activation est IsLeadCapture, pas IsEnabled.

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la capture de leads (base)

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsLeadCapture`true \| false	par exemple `false`
`LeadCaptureTitle`	—
`IsLeadAllowSkip`true \| false	par exemple `false`
`LeadSkipText`	—
`LeadFormAfterPages`number	par exemple `0`
`LeadAfterPages`number	par exemple `0`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les champs de lead Définir les champs de lead personnalisés Définir les libellés de lead Définir la confidentialité des leads Définir la vérification des leads Définir le webhook de lead Définir Google Sheets pour les leads Lister les leads

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsLeadCapturetrue / false

LeadCaptureTitle

IsLeadAllowSkiptrue / false

LeadSkipText

LeadFormAfterPagesnumber

LeadAfterPagesnumber

Définir les champs de lead

Active/désactive chaque champ standard de capture de leads (nom, e-mail, téléphone, société, etc.) et indique s'il est obligatoire.

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la capture de leads (base)(active la capture de leads)→Définir les champs de lead

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsLeadEmail`true \| false	par exemple `true`
`IsLeadEmailMandatory`true \| false	par exemple `true`
`IsLeadName`true \| false	par exemple `true`
`IsLeadNameMandatory`true \| false	par exemple `false`
`IsLeadPhone`true \| false	par exemple `false`
`IsLeadPhoneMandatory`true \| false	par exemple `false`
`IsLeadCompany`true \| false	par exemple `false`
`IsLeadCompanyMandatory`true \| false	par exemple `false`
`IsLeadDate`true \| false	par exemple `false`
`IsLeadDateMandatory`true \| false	par exemple `false`
`LeadPhoneCountry`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la capture de leads (base)Définir les champs de lead personnalisés Définir les libellés de lead

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsLeadEmailtrue / false

IsLeadEmailMandatorytrue / false

IsLeadNametrue / false

IsLeadNameMandatorytrue / false

IsLeadPhonetrue / false

IsLeadPhoneMandatorytrue / false

IsLeadCompanytrue / false

IsLeadCompanyMandatorytrue / false

IsLeadDatetrue / false

IsLeadDateMandatorytrue / false

LeadPhoneCountry

Définir les champs de lead personnalisés

Définit des champs personnalisés supplémentaires sur le formulaire de capture de leads, au-delà des champs standard nom/e-mail/téléphone.

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la capture de leads (base)(active la capture de leads)→Définir les champs de lead personnalisés

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsLeadCustom1`true \| false	par exemple `false`
`IsLeadCustom1Mandatory`true \| false	par exemple `false`
`Custom1Label`	—
`IsLeadCustom2`true \| false	par exemple `false`
`IsLeadCustom2Mandatory`true \| false	par exemple `false`
`Custom2Label`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les champs de lead Définir les libellés de lead

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsLeadCustom1true / false

IsLeadCustom1Mandatorytrue / false

Custom1Label

IsLeadCustom2true / false

IsLeadCustom2Mandatorytrue / false

Custom2Label

Définir les libellés de lead

Définit les libellés affichés et le texte indicatif des champs du formulaire de capture de leads.

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la capture de leads (base)(active la capture de leads)→Définir les libellés de lead

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`LeadEmail`email	—
`LeadName`	—
`LeadPhone`phone	—
`LeadCompany`	—
`LeadDate`	—
`LeadButton`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les champs de lead Définir les champs de lead personnalisés

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

LeadEmailemail

LeadName

LeadPhonephone

LeadCompany

LeadDate

LeadButton

Définir la confidentialité des leads

Configure le texte et les options de confidentialité/consentement de la capture de leads (par exemple la case de consentement RGPD).

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la capture de leads (base)(active la capture de leads)→Définir la confidentialité des leads

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsLeadPrivacyPolicy`true \| false	par exemple `false`
`PrivacyPolicyURL`URL	—
`PrivacyPolicyText`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la capture de leads (base)

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsLeadPrivacyPolicytrue / false

PrivacyPolicyURLURL

PrivacyPolicyText

Définir la vérification des leads

Active ou désactive la vérification de l'e-mail des leads, obligeant les lecteurs à confirmer leur e-mail avant l'accès.

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la capture de leads (base)(active la capture de leads)→Définir la vérification des leads

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsVerifyEmail`true \| false	par exemple `false`
`IsVerifyMobile`true \| false	par exemple `false`
`TwillioAPIKey`	Ta clé d'API Twilio (le nom du champ conserve l'orthographe d'origine « Twillio »).
`EmailVerifyTitleText`	—
`EmailVerifyButtonText`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir la capture de leads (base)

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsVerifyEmailtrue / false

IsVerifyMobiletrue / false

TwillioAPIKeyTa clé d'API Twilio (le nom du champ conserve l'orthographe d'origine « Twillio »).

EmailVerifyTitleText

EmailVerifyButtonText

Définir le webhook de lead

Définit une URL de webhook qui reçoit chaque nouveau lead (enregistrée comme webhook de nouveau lead). Utilise test-webhook pour vérifier qu'il se déclenche.

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la capture de leads (base)(active la capture de leads)→Définir le webhook de lead

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

WebhookURL_NewLeadURL L'URL de ton endpoint — reçoit une charge utile JSON pour chaque nouveau lead.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésTester le webhook Lister les leads Définir Google Sheets pour les leads

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

WebhookURL_NewLeadURLL'URL de ton endpoint — reçoit une charge utile JSON pour chaque nouveau lead.

Tester le webhook

Envoie une charge utile de TEST au webhook de lead configuré du flipbook pour que tu puisses vérifier le format de livraison sans véritable lead. Renvoie l'erreur « No lead webhook is configured for this flipbook. » si aucun n'est défini. La structure de la charge utile correspond à un vrai lead (clés : pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2) mais avec des valeurs factices (pdf_id:"-1", pdf_name:"Test PDF", ...). Aucun véritable lead n'est stocké et aucun e-mail de notification n'est envoyé.

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le webhook de lead(un webhook doit d'abord être configuré)→Tester le webhook

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le webhook de lead

POST/api/test-webhook/{flipbookId}

curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Définir Google Sheets pour les leads

Connecte la capture de leads à une feuille Google Sheets — chaque nouveau lead est ajouté à la feuille que tu indiques (ID de la feuille + nom).

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir la capture de leads (base)(active la capture de leads)→Définir Google Sheets pour les leads

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`GoogleSheetURL`URL	—
`GoogleSheetIDKey`	—
`GoogleSheetName`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le webhook de lead Lister les leads

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

GoogleSheetURLURL

GoogleSheetIDKey

GoogleSheetName

Sections — Notifications et modèles d'e-mail

Définir les notifications

Configure les notifications par e-mail que tu reçois pour ce flipbook (nouveau lead, nouvelle vue, nouvelle vente).

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir les notifications

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`NotificationsEmail`email	—
`IsSendEmailOnView`true \| false	par exemple `false`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le modèle d'e-mail — Nouveau lead Définir le modèle d'e-mail — Nouvelle vue Définir le modèle d'e-mail — Nouvelle vente

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

NotificationsEmailemail

IsSendEmailOnViewtrue / false

Définir le modèle d'e-mail — Nouveau lead

Définit l'e-mail envoyé lors d'un événement nouveau lead. Envoie des valeurs vides pour restaurer le modèle NEW_LEAD par défaut.

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le modèle d'e-mail — Nouveau lead

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`EmailLeadSubject`	—
`EmailLeadBody`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les notifications Définir la capture de leads (base)

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

EmailLeadSubject

EmailLeadBody

Définir le modèle d'e-mail — Nouvelle vue

Définit le modèle d'e-mail envoyé lors d'une notification de nouvelle vue. Envoie une valeur vide pour restaurer le modèle NEW_VIEW par défaut.

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le modèle d'e-mail — Nouvelle vue

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`EmailViewSubject`	—
`EmailViewBody`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les notifications

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

EmailViewSubject

EmailViewBody

Définir le modèle d'e-mail — Nouvelle vente

Définit le modèle d'e-mail envoyé lors d'une notification de nouvelle vente. Envoie une valeur vide pour restaurer le modèle NEW_SALE par défaut.

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le modèle d'e-mail — Nouvelle vente

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`EmailSaleSubject`	—
`EmailSaleBody`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les notifications Définir les réglages de vente

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

EmailSaleSubject

EmailSaleBody

Sections — Ventes

Définir les réglages de vente

Configure la vente du flipbook (prix, devise, options). Activer le mode vente active automatiquement la vérification de l'e-mail et rend l'e-mail du lead obligatoire.

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Lister les devises(choisis SaleCurr)→Définir les réglages de vente

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsForSale`true \| false	par exemple `false`
`SaleCurr`	De /api/list-currencies
`SaleAmount`number	par exemple `0`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésLister les devises Définir le texte de la page de vente Définir la passerelle de paiement Définir l'achat d'un flipbook

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsForSaletrue / false

SaleCurrDe /api/list-currencies

SaleAmountnumber

Définir le texte de la page de vente

Définit le texte marketing affiché sur la page de vente / de paiement du flipbook.

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir les réglages de vente(active la vente)→Définir le texte de la page de vente

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`SalePageTitle`	—
`SaleAccessPageTitle`	—
`SalePurchaseButtonText`	—
`SaleButtonText`	—
`SaleAccessButtonText`	—
`SaleButtonColor`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les réglages de vente Définir la passerelle de paiement

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

SalePageTitle

SaleAccessPageTitle

SalePurchaseButtonText

SaleButtonText

SaleAccessButtonText

SaleButtonColor

Définir la passerelle de paiement

Sélectionne et configure la passerelle de paiement utilisée pour vendre ce flipbook.

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir les réglages de vente(active la vente)→Définir la passerelle de paiement

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`SaleGatewayName`	—
`SaleGatewayKey`	—
`SaleGatewaySecret`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les réglages de vente Définir l'achat d'un flipbook

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

SaleGatewayName

SaleGatewayKey

SaleGatewaySecret

Sections — Approbation

Définir le bouton d'approbation

Ajoute un bouton de demande d'approbation au lecteur. Son activation déclenche le workflow de demande d'approbation.

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(DocType=document — éléments Document uniquement)→Définir le bouton d'approbation

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsApprovalButton`true \| false	par exemple `false`
`ApprovalButtonText`	—
`ApprovalButtonColor`	—
`ApprovalButtonTextColor`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les modèles d'e-mail d'approbation

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsApprovalButtontrue / false

ApprovalButtonText

ApprovalButtonColor

ApprovalButtonTextColor

Définir les modèles d'e-mail d'approbation

Définit les modèles d'e-mail utilisés par le workflow d'approbation. Des valeurs vides récupèrent les valeurs par défaut.

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(DocType=document — éléments Document uniquement)→Définir les modèles d'e-mail d'approbation

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`EmailApproveRequestSubject`	—
`EmailApproveRequestBody`	—
`EmailApproveRemindSubject`	—
`EmailApproveRemindBody`	—
`EmailApproveSubmitSubject`	—
`EmailApproveSubmitBody`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le bouton d'approbation

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

EmailApproveRequestSubject

EmailApproveRequestBody

EmailApproveRemindSubject

EmailApproveRemindBody

EmailApproveSubmitSubject

EmailApproveSubmitBody

Sections — Partage

Définir l'interrupteur principal de partage

Interrupteur principal d'activation/désactivation des boutons de partage du lecteur.

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'interrupteur principal de partage

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsShareButtonstrue | false par exemple false

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir les canaux de partage

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsShareButtonstrue / false

Définir les canaux de partage

Active/désactive individuellement chaque canal de partage social (Facebook, X, LinkedIn, WhatsApp, e-mail, etc.) dans le menu de partage du lecteur.

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir les canaux de partage

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsShareFacebook`true \| false	par exemple `true`
`IsShareTwitter`true \| false	par exemple `true`
`IsShareWhatsApp`true \| false	par exemple `true`
`IsShareTelegram`true \| false	par exemple `false`
`IsShareLinkedIn`true \| false	par exemple `true`
`IsSharePinterest`true \| false	par exemple `false`
`IsShareReddit`true \| false	par exemple `false`
`IsShareTumblr`true \| false	par exemple `false`
`IsShareMessenger`true \| false	par exemple `false`
`IsShareEmail`true \| false	par exemple `true`
`IsShareLine`true \| false	par exemple `false`
`IsShareWeChat`true \| false	par exemple `false`
`IsShareInstagram`true \| false	par exemple `false`
`IsShareFlipboard`true \| false	par exemple `false`
`IsShareGeneral`true \| false	par exemple `true`

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir l'interrupteur principal de partage

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'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsShareFacebooktrue / false

IsShareTwittertrue / false

IsShareWhatsApptrue / false

IsShareTelegramtrue / false

IsShareLinkedIntrue / false

IsSharePinteresttrue / false

IsShareReddittrue / false

IsShareTumblrtrue / false

IsShareMessengertrue / false

IsShareEmailtrue / false

IsShareLinetrue / false

IsShareWeChattrue / false

IsShareInstagramtrue / false

IsShareFlipboardtrue / false

IsShareGeneraltrue / false

Sections — Suivi et IA

Définir le suivi analytique

Ajoute tes propres identifiants de suivi analytique (par exemple Google Analytics, GTM, Facebook Pixel) au flipbook hébergé.

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le suivi analytique

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`FacebookAnalyticsCode`	—
`GoogleAnalyticsCode`	—
`GoogleTagManager`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut 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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

FacebookAnalyticsCode

GoogleAnalyticsCode

GoogleTagManager

Définir le fournisseur d'IA

Configure le fournisseur d'IA utilisé pour les fonctionnalités d'IA — le nom du fournisseur et sa clé d'API.

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le fournisseur d'IA

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`AIProvider`	—
`AIKey`	—

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir l'assistant virtuel

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

AIProvider

AIKey

Définir l'assistant virtuel

Configure les réglages de base de l'assistant virtuel intégré au lecteur (chat/aide).

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir l'assistant virtuel

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`IsVA`true \| false	par exemple `false`
`VAButtonText`	—
`VAButtonColor`	—
`VAButtonTextColor`	—
`VAText`	Invite / instructions de l'assistant
`VAEmbeddings`	Blob d'embeddings (chaîne)

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir le texte de statut de l'assistant virtuel Définir le fournisseur d'IA

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

IsVAtrue / false

VAButtonText

VAButtonColor

VAButtonTextColor

VATextInvite / instructions de l'assistant

VAEmbeddingsBlob d'embeddings (chaîne)

Définir le texte de statut de l'assistant virtuel

Définit le texte de statut/d'accueil affiché par l'assistant virtuel intégré au lecteur.

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}

PrérequisQui suis-je(une clé d'API valide)→Créer à partir d'un fichier(récupère un flipbookId)→Définir le texte de statut de l'assistant virtuel

Paramètres de chemin

flipbookIdnumber ID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

`VAButtonStatus1`	Libellé du statut d'écoute
`VAButtonStatus2`	Libellé du statut d'enregistrement
`VAButtonStatus3`	Libellé du statut de traitement
`VAButtonStatus4`	Libellé du statut de prise de parole

Réponses d'erreur

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

Une clé manquante/invalide est rejetée avec un HTTP 401 (une page HTML, pas de JSON). Toute autre erreur renvoie un HTTP 200 avec { "Result": "ERROR", "Message": … } — alors branche-toi toujours sur Result, pas seulement sur le statut HTTP.

AssociésDéfinir l'assistant virtuel

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>'

Exemple de réponse200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Colle ta clé d'API dans « Ta clé d'API » en haut — puis remplis les champs ci-dessous et envoie.

Paramètres de chemin — requis pour identifier l'élément

flipbookIdrequirednumberID numérique du flipbook/document — renvoyé par create-by-file / create-by-url (sous le nom ID) ou par list.

Paramètres du corps

VAButtonStatus1Libellé du statut d'écoute

VAButtonStatus2Libellé du statut d'enregistrement

VAButtonStatus3Libellé du statut de traitement

VAButtonStatus4Libellé du statut de prise de parole

Référence de l'API FlipLink

Introduction

Authentification

Format de réponse et types de résultat

Pagination

Limites de débit

Limites et quotas du forfait

Erreurs

Profil

Qui suis-je

Réponses d'erreur

Récupérer le profil

Réponses d'erreur

Définir le profil (partiel)

Paramètres du corps

Réponses d'erreur

Abonnement et paiements

Récupérer les détails de l'abonnement

Réponses d'erreur

Lister les paiements

Réponses d'erreur

Éléments — Création

Créer à partir d'un fichier

Corps (multipart/form-data)

Réponses d'erreur

Créer à partir d'une URL

Paramètres du corps

Réponses d'erreur

Éléments — Lecture

Récupérer un élément

Paramètres de chemin

Réponses d'erreur

Rechercher par URL

Paramètres de requête

Réponses d'erreur

Lister

Paramètres de requête

Réponses d'erreur

Récupérer l'URL du PDF

Paramètres de chemin

Réponses d'erreur

Récupérer le lien de partage

Paramètres de chemin

Réponses d'erreur

Éléments — Modification

Dupliquer

Paramètres de chemin

Paramètres du corps

Réponses d'erreur

Remplacer le PDF (fichier)

Paramètres de chemin

Corps (multipart/form-data)

Réponses d'erreur

Remplacer le PDF (URL)

Paramètres de chemin

Paramètres du corps

Réponses d'erreur

Enregistrer comme modèle (bascule)

Paramètres de chemin

Paramètres du corps

Réponses d'erreur

Affecter à un dossier

Paramètres de chemin

Paramètres du corps

Réponses d'erreur

Définir la page de couverture/dos (fichier)

Paramètres de chemin

Corps (multipart/form-data)

Réponses d'erreur

Définir la page de couverture/dos (URL)

Paramètres de chemin

Paramètres du corps

Réponses d'erreur

Supprimer la page de couverture/dos

Paramètres de chemin

Réponses d'erreur

Définir/supprimer l'expiration

Paramètres de chemin

Paramètres du corps

Réponses d'erreur