Ein Flipbook verkaufen und Verkäufe auslesen

Was du tun kannst

Diese fünf Endpunkte decken den vollen Lebenszyklus ab, ein Flipbook zu verkaufen und zu verfolgen, was es einbringt:

• Den Verkauf konfigurieren – lege Preis und Währung fest sowie, ob das Flipbook zum Verkauf steht.
• Die Checkout-Seite anpassen – Titel, Button-Text und Button-Farbe.
• Ein Zahlungs-Gateway wählen – wähle das Gateway und lege seine Zugangsdaten fest.
• Einen Kauf erfassen – protokolliere einen abgeschlossenen Verkauf über deinen eigenen Zahlungs-Flow.
• Deine Verkäufe auslesen – liste abgeschlossene (oder Abandoned-Cart-)Verkaufsdatensätze auf, mit Paging und CSV-Export.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Jeder Endpunkt außer List Sales nimmt die numerische ID des Flipbooks als {flipbookId}-Pfadparameter entgegen – zum Beispiel .../set-sale-settings/96216.
• Die Schreib-Endpunkte (Set Sale Settings, Set Sale Page Text, Set Sale Gateway, Set Flipbook Purchase) senden ihren Body als form-urlencoded Felder (KEIN JSON).

Den Verkauf konfigurieren

PUT /api/set-sale-settings/{flipbookId} konfiguriert den Verkauf des Flipbooks (Preis, Währung, Optionen). Wenn du den Verkaufsmodus aktivierst, wird die E-Mail-Verifizierung automatisch mitaktiviert und die Lead-E-Mail zur Pflicht.

Wichtige Felder:

• SaleAmount – der Preis in ganzen Währungseinheiten (z. B. Dollar), Dezimalstellen sind erlaubt. 9.99 bedeutet $9.99 und 1000 bedeutet $1,000 – das ist KEIN Cent-/Minor-Units-Wert.
• SaleCurr – der Währungscode (Standard usd). Wähle einen gültigen Code aus /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'

Antwort:

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

Die Checkout-Seite anpassen

PUT /api/set-sale-page-text/{flipbookId} legt die Marketing-Texte fest, die auf der Verkaufs-/Checkout-Seite des Flipbooks gezeigt werden.

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

Antwort:

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

Ein Zahlungs-Gateway wählen

PUT /api/set-sale-gateway/{flipbookId} wählt und konfiguriert das Zahlungs-Gateway, das beim Verkauf dieses Flipbooks verwendet wird.

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

Antwort:

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

Einen Kauf erfassen

POST /api/set-flipbook-purchase/{flipbookId} erfasst einen abgeschlossenen Flipbook-Verkauf (Kauf) – nutze es, um Käufe zu protokollieren, die über deinen eigenen Zahlungs-Flow getätigt wurden, ohne FlipLinks Stripe-Checkout zu durchlaufen. Sende die Email des Käufers und deine Zahlungs-Gateway-Referenz PaymentRef (bei Stripe die PaymentIntent-ID, pi_...); beide sind erforderlich. Sende NICHT Amount/Currency – die werden serverseitig aus deiner Zahlungsreferenz abgeleitet.

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'

Antwort:

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

Deine Verkäufe auslesen

GET /api/list-sales listet Verkaufs-/Kaufdatensätze deiner Flipbooks auf (Käufer-E-Mail, Flipbook, Betrag, Datum) plus die Spaltendefinitionen für die Verkaufstabelle. Es unterstützt Paging und CSV-Export über IsDownload. Setze IsAbandoned=true, um statt abgeschlossener Verkäufe Abandoned-Cart-Verkäufe zurückzugeben.

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'

Antwort:

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

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header vorhanden und korrekt ist.
• Unbekannte flipbookId (oder eine, die nicht zu deinem Schlüssel gehört) → HTTP 200 mit { "Result": "ERROR", "Message": "Item not found" }. Das gilt für Set Sale Settings, Set Sale Page Text, Set Sale Gateway und Set Flipbook Purchase.
• Unbekanntes oder falsch geschriebenes Body-Feld → HTTP 200 mit { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }.
• Fehlendes Pflichtfeld beim Kauf (Set Flipbook Purchase) → { "Result": "ERROR", "Message": "Email is required." } oder { "Result": "ERROR", "Message": "PaymentRef is required." }.

Hinweise

• Den Verkaufsmodus (IsForSale) über Set Sale Settings zu aktivieren, aktiviert automatisch die E-Mail-Verifizierung und macht die Lead-E-Mail zur Pflicht.
• Set Flipbook Purchase ist für Käufe über deinen eigenen Zahlungs-Flow gedacht – es lässt dich einen Verkauf protokollieren, ohne FlipLinks Stripe-Checkout zu durchlaufen.