Referenz-Abfragen (Vorlagen, Skins, Währungen, Musik)

Was du tun kannst

Vier schreibgeschützte Endpunkte geben die Referenzlisten zurück, aus denen du beim Konfigurieren eines Flipbooks schöpfst. Jeder listet die gültigen Optionen für eine bestimmte Einstellung auf, sodass du eine ID oder einen Namen aus der Liste wählen und an den passenden Schreib-Endpunkt übergeben kannst:

• List templates – die wiederverwendbaren Flipbook-Vorlagen, die auf deinem Konto gespeichert sind.
• List skins – die verfügbaren Viewer-Skins/Themes, jeweils mit ihrer gebündelten Hintergrund-URL.
• List currencies – die Währungen, die beim Verkauf eines Flipbooks verfügbar sind.
• List background music – die eingebauten Hintergrundmusik-Titel, die du an einen Flipbook-Viewer anhängen kannst.

Bevor du loslegst

• Authentifiziere dich mit deinem API-Schlüssel – gesendet entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY.
• Basis-URL: https://go.fliplink.me.
• Das sind GET-Abfragen ohne Request-Body und ohne Pfadparameter – Optionen werden dort, wo vermerkt, als Query-Strings übergeben.

Vorlagen auflisten

Listet die wiederverwendbaren Flipbook-Vorlagen auf, die auf deinem Konto gespeichert sind. Filtere nach DocType. Verwende die ID einer Vorlage mit save-as-template / den Erstellungs-Flows.

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

Antwort:

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

Der Query-Parameter DocType akzeptiert 0 = Flipbook (Standard) oder 1 = Document.

Skins auflisten

Listet die verfügbaren Viewer-Skins/Themes auf; jede Zeile trägt die gebündelte Hintergrund-URL des Skins. Verwende den Name eines Skins mit set-skin.

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

Antwort:

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

Der Query-Parameter Type ist ein boolean: false = Flipbook-Skins, true = Document-Skins.

Währungen auflisten

Listet die Währungen auf, die beim Verkauf eines Flipbooks verfügbar sind (für die Verkaufs-/Checkout-Einstellungen).

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

Antwort:

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

Hintergrundmusik auflisten

Listet die eingebauten Hintergrundmusik-Titel auf, die du an einen Flipbook-Viewer anhängen kannst.

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

Antwort:

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

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. Das gilt für alle vier Endpunkte.