Vendre un flipbook et lire les ventes

Ce que tu peux faire

Ces cinq endpoints couvrent tout le cycle de vie de la vente d'un flipbook et du suivi de ce qu'il rapporte :

• Configurer la vente — définis le prix, la devise, et si le flipbook est à vendre.
• Personnaliser la page de paiement — titres, texte des boutons et couleur des boutons.
• Choisir une passerelle de paiement — sélectionne la passerelle et définis ses identifiants.
• Enregistrer un achat — consigne une vente réalisée via ton propre flux de paiement.
• Lire tes ventes — liste les enregistrements de ventes finalisées (ou de paniers abandonnés), avec pagination et export CSV.

Avant de commencer

• Une clé d'API — envoyée dans l'en-tête X-Api-Key, ou sous la forme Authorization: Bearer YOUR_API_KEY, à chaque requête.
• Toutes les requêtes vont vers l'URL de base https://go.fliplink.me.
• Chaque endpoint sauf List Sales prend l'ID numérique du flipbook comme paramètre de chemin {flipbookId} — par exemple .../set-sale-settings/96216.
• Les endpoints d'écriture (Set Sale Settings, Set Sale Page Text, Set Sale Gateway, Set Flipbook Purchase) envoient leur corps en champs form-urlencoded (PAS du JSON).

Configurer la vente

PUT /api/set-sale-settings/{flipbookId} configure la vente du flipbook (prix, devise, options). Activer le mode vente active automatiquement la vérification des e-mails et rend l'e-mail du prospect obligatoire.

Champs clés :

• SaleAmount — le prix en unités monétaires entières (par exemple des dollars), avec décimales autorisées. 9.99 signifie $9.99 et 1000 signifie $1,000 — ce n'est PAS une valeur en centimes/unités mineures.
• SaleCurr — le code de devise (par défaut usd). Choisis un code valide dans /api/list-currencies.

curl -X PUT 'https://go.fliplink.me/api/set-sale-settings/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsForSale=true' \
  --data-urlencode 'SaleCurr=usd' \
  --data-urlencode 'SaleAmount=9.99'

Réponse :

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

Personnaliser la page de paiement

PUT /api/set-sale-page-text/{flipbookId} définit le texte marketing affiché sur la page de vente / paiement du flipbook.

curl -X PUT 'https://go.fliplink.me/api/set-sale-page-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SalePageTitle=' \
  --data-urlencode 'SaleAccessPageTitle=' \
  --data-urlencode 'SalePurchaseButtonText=' \
  --data-urlencode 'SaleButtonText=' \
  --data-urlencode 'SaleAccessButtonText=' \
  --data-urlencode 'SaleButtonColor='

Réponse :

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

Choisir une passerelle de paiement

PUT /api/set-sale-gateway/{flipbookId} sélectionne et configure la passerelle de paiement utilisée pour vendre ce flipbook.

curl -X PUT 'https://go.fliplink.me/api/set-sale-gateway/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SaleGatewayName=' \
  --data-urlencode 'SaleGatewayKey=' \
  --data-urlencode 'SaleGatewaySecret='

Réponse :

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

Enregistrer un achat

POST /api/set-flipbook-purchase/{flipbookId} enregistre une vente (achat) finalisée d'un flipbook — utilise-le pour consigner les achats réalisés via ton propre flux de paiement, sans passer par le paiement Stripe de FlipLink. Envoie l'Email de l'acheteur et ta référence de passerelle de paiement PaymentRef (pour Stripe, l'ID du PaymentIntent, pi_...) ; les deux sont requis. N'envoie PAS Amount/Currency — ils sont dérivés côté serveur à partir de ta référence de paiement.

curl -X POST 'https://go.fliplink.me/api/set-flipbook-purchase/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Email=customer@example.com' \
  --data-urlencode 'PaymentRef=pi_3O1234567890abcdef'

Réponse :

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

Lire tes ventes

GET /api/list-sales 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. Il prend en charge la pagination et l'export CSV via IsDownload. Mets IsAbandoned=true pour renvoyer les ventes de paniers abandonnés au lieu des ventes finalisées.

curl -X GET 'https://go.fliplink.me/api/list-sales?ItemIDs=&SearchText=&PageNo=1&Offset=0&IsDownload=true&IsAbandoned=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

Réponse :

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

Erreurs possibles

• Clé d'API manquante ou invalide → HTTP 401. Cela renvoie une simple page HTML « Unauthorized » — il n'y a pas de corps JSON. Vérifie que l'en-tête X-Api-Key est présent et correct.
• flipbookId inconnu (ou non détenu par ta clé) → HTTP 200 avec { "Result": "ERROR", "Message": "Item not found" }. Cela s'applique à Set Sale Settings, Set Sale Page Text, Set Sale Gateway et Set Flipbook Purchase.
• Champ de corps inconnu ou mal orthographié → HTTP 200 avec { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }.
• Champ d'achat requis manquant (Set Flipbook Purchase) → { "Result": "ERROR", "Message": "Email is required." } ou { "Result": "ERROR", "Message": "PaymentRef is required." }.

Remarques

• Activer le mode vente (IsForSale) via Set Sale Settings active automatiquement la vérification des e-mails et rend l'e-mail du prospect obligatoire.
• Set Flipbook Purchase sert aux achats réalisés via ton propre flux de paiement — il te permet de consigner une vente sans passer par le paiement Stripe de FlipLink.