Ein Flipbook mit einem Passwort schützen

Zugriffskontrolle

Schalte den Passwortschutz für ein Flipbook ein oder aus und passe die Passwortseite – Titel, Eingabe-Platzhalter und Button – mit einem einzigen API-Aufruf an.

In dieser Diskussion verwendete APIs

Etwas in dieser Anleitung ungenau oder veraltet?

Was du tun kannst

Der Passwortschutz setzt eine Sperre vor ein Flipbook: Betrachter müssen das richtige Passwort eingeben, bevor die Inhalte geladen werden. Mit einem einzigen API-Aufruf kannst du:

  • Den Schutz einschalten und das Zugangspasswort festlegen.
  • Den Schutz wieder ausschalten.
  • Die Passwortseite anpassen – die Überschrift, den Eingabe-Platzhalter und die Button-Beschriftung.

Bevor du loslegst

Du brauchst:

  • Einen API-Schlüssel – wird bei jeder Anfrage als X-Api-Key-Header gesendet.
  • Die flipbookId – die numerische ID, die beim Erstellen eines Flipbooks zurückgegeben wird (als ID) oder über die Listen-Endpunkte.
  • Anfragen gehen an die Basis-URL https://go.fliplink.me.

Der Body ist form-urlencoded (kein JSON).

Parameter

Sende diese als urlencodierte Felder an PUT /api/set-password-access/{flipbookId}:

FeldTypWas es bewirkt
IsPasswordProtectedbooleantrue schaltet die Passwortsperre ein; false schaltet sie aus
PasswordtextDas Zugangspasswort, das Betrachter eingeben müssen
PwdTitletextÜberschrift auf der Passwortseite (optional)
PwdPlaceholdertextPlatzhaltertext im Passwort-Eingabefeld (optional)
PwdButtontextBeschriftung des Absende-Buttons (optional)

Passwortschutz einschalten

Setze IsPasswordProtected=true und gib das Password an. Die drei Pwd*-Felder sind optional – füge sie hinzu, um anzupassen, was der Betrachter sieht.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=true' \
  --data-urlencode 'Password=spring-2026' \
  --data-urlencode 'PwdTitle=Enter the access code' \
  --data-urlencode 'PwdPlaceholder=Access code' \
  --data-urlencode 'PwdButton=View document'

Antwort:

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

Passwortschutz ausschalten

Setze IsPasswordProtected=false. Die übrigen Felder kannst du leer lassen.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=' \
  --data-urlencode 'PwdTitle=' \
  --data-urlencode 'PwdPlaceholder=' \
  --data-urlencode 'PwdButton='

Antwort:

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

Die Passwortseite anpassen

Mit den Feldern PwdTitle, PwdPlaceholder und PwdButton kannst du die Sperre auf dein Publikum zuschneiden – etwa indem du sie für ein Kundenportal „Zugangscode“ nennst oder an den Ton deiner Marke anpasst. Sie sind optional; lass sie weg (oder sende sie leer), um die Standardwerte zu verwenden.

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" }.
  • Falsch geschriebenes Body-Feld → HTTP 200 mit { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }. Gleiche die Feldnamen mit der Tabelle oben ab.

Hinweise

  • Gib das Passwort auf getrenntem Weg weiter. Sende den Flipbook-Link und das Passwort über verschiedene Kanäle – ein Passwort in derselben E-Mail wie der Link bietet kaum Schutz.
  • Passwortschutz ist nur eine Ebene. Er kontrolliert den Zutritt, nicht wer der Betrachter ist. Um den Zugriff auf bestimmte Personen zu beschränken, kombiniere ihn mit einer E-Mail-Erlaubnisliste; um den Zugriff zeitlich zu begrenzen, verbinde ihn mit einem Link-Ablauf.

Verwandte Diskussionen