Die E-Mail-Erlaubnisliste eines Flipbooks verwalten

Was du tun kannst

Wenn ein Flipbook per E-Mail geschützt ist, können nur Adressen auf seiner Erlaubnisliste es öffnen. Die API bietet dir vier Möglichkeiten, diese Liste zu verwalten, ohne jemals das Dashboard zu öffnen:

• Lesen der aktuellen Liste, damit du sie nie selbst nachverfolgen musst.
• Hinzufügen einer oder mehrerer Adressen (ohne die bereits vorhandenen anzutasten).
• Entfernen bestimmter Adressen.
• Ersetzen der gesamten Liste mit einem einzigen Aufruf.

Diese Anleitung geht jede Möglichkeit durch: die genaue Form der Anfrage, die Antworten, die du zurückbekommst, und den einen Stolperstein, über den viele fallen (den Unterschied zwischen Hinzufügen und Ersetzen).

Bevor du loslegst

Du brauchst:

• Einen API-Schlüssel – wird bei jeder Anfrage als X-Api-Key-Header gesendet. (Deinen Schlüssel findest du auf der API-Seite deines Kontos.)
• Die flipbookId eines Flipbooks, das per E-Mail geschützt ist. Die Erlaubnisliste regelt den Betrachterzugriff bei E-Mail-geschützten Flipbooks.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.

Das Feld EmailsAllowed bei Schreibanfragen ist form-urlencoded (kein JSON) und durch Semikolons getrennt (alice@corp.com;bob@corp.com). Kommas werden akzeptiert und automatisch in Semikolons umgewandelt.

Die vier Endpunkte auf einen Blick

Die aktuelle Liste lesen

Fang immer hier an – lies die Liste, damit du ihren genauen Stand kennst, bevor du etwas änderst.

curl -X GET 'https://go.fliplink.me/api/get-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com"], "Count": 2 }

EmailsAllowed kommt als sauberes JSON-Array zurück (nicht als Semikolon-String), und Count ist dessen Länge.

Adressen hinzufügen (ohne den Rest zu löschen)

Um neuen Personen Zugriff zu geben und dabei alle bereits auf der Liste zu behalten, verwende Add. Das ist additiv – es entfernt niemanden.

curl -X POST 'https://go.fliplink.me/api/add-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=carol@corp.com;dan@corp.com'

Antwort (die vollständige, aktualisierte Liste):

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com", "carol@corp.com", "dan@corp.com"], "Count": 4 }

Bestimmte Adressen entfernen

Um bestimmten Personen den Zugriff zu entziehen, verwende Delete. Es werden nur die von dir angegebenen Adressen entfernt; alle anderen bleiben.

curl -X DELETE 'https://go.fliplink.me/api/delete-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=carol@corp.com'

Antwort:

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com", "dan@corp.com"], "Count": 3 }

Die gesamte Liste ersetzen ⚠️

Set überschreibt die gesamte Erlaubnisliste mit genau den Adressen, die du sendest. Das ist der Stolperstein: Wenn du eine einzelne Adresse sendest, wird jede andere entfernt.

# This does NOT add one person — it makes the list ONLY this one person.
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=alice@corp.com'

Nach diesem Aufruf ist alice@corp.com die einzige Adresse, die das Flipbook ansehen kann. Verwende Set nur dann, wenn du die komplette Liste wirklich von Grund auf neu festlegen willst (zum Beispiel, um ein brandneues Flipbook zu bestücken). Für alltägliche Änderungen nach dem Muster „diese Person freischalten / jene Person sperren“ verwende stattdessen Add und Delete.

Um die Liste vollständig zu leeren, sende einen leeren Wert:

curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed='

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

Eine schnelle Faustregel: Result: "OK" bedeutet, dass die Änderung angewendet wurde; Result: "ERROR" bedeutet, dass sie es nicht wurde – lies die Message für den Grund.

Empfohlenes Vorgehen

Für sichere, vorhersehbare Änderungen:

1. GET der aktuellen Liste.
2. Entscheide, wen du hinzufügen oder entfernen willst.
3. Verwende Add / Delete für gezielte Änderungen (sie tasten den Rest der Liste nie an).
4. Verwende Set nur dann, wenn du die ganze Liste wirklich auf einmal ersetzen willst.
5. GET erneut, um den Endzustand zu bestätigen.

Diese Schleife aus „lesen → ändern → zurücklesen“ bedeutet, dass du die Liste nie in deinem eigenen System nachhalten musst und nie versehentlich Zugriffe löschst, weil du Set verwendest, obwohl du Add meintest.