De e-mailtoegangslijst van een flipbook beheren

Toegangsbeheer

Bepaal precies wie een afgeschermde flipbook mag openen door de e-mailtoegangslijst voor kijkers via de API te lezen, aan te vullen, in te korten of te vervangen.

API's die in deze discussie worden gebruikt

Iets onjuist of verouderd in deze gids?

Wat je kunt doen

Wanneer een flipbook is afgeschermd met e-mail, kunnen alleen adressen op de toegangslijst hem openen. De API geeft je vier manieren om die lijst te beheren zonder ooit het dashboard te openen:

  • Lees de huidige lijst, zodat je die nooit zelf hoeft bij te houden.
  • Voeg een of meer adressen toe (zonder de adressen die er al op staan te verstoren).
  • Verwijder specifieke adressen.
  • Vervang de hele lijst in één aanroep.

In deze gids lopen we elk hiervan door: de exacte vorm van het verzoek, de responses die je terugkrijgt, en het ene addertje waar mensen over struikelen (het verschil tussen toevoegen en vervangen).

Voordat je begint

Je hebt nodig:

  • Een API-sleutel — meegestuurd als de X-Api-Key-header op elk verzoek. (Je sleutel staat op de API-pagina van je account.)
  • De flipbookId van een flipbook die is afgeschermd met e-mail. De toegangslijst regelt de toegang van kijkers op flipbooks met een e-mailgate.
  • Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.

Het veld EmailsAllowed op schrijfverzoeken is form-urlencoded (geen JSON) en gescheiden door puntkomma's (alice@corp.com;bob@corp.com). Komma's worden geaccepteerd en automatisch omgezet naar puntkomma's.

De vier endpoints in één oogopslag

DoelMethode & padEffect
De lijst lezenGET /api/get-email-allow-list/{flipbookId}Geeft de huidige adressen + een aantal terug
Adressen toevoegenPOST /api/add-email-allow-list/{flipbookId}Voegt toe aan de lijst (behoudt bestaande)
Adressen verwijderenDELETE /api/delete-email-allow-list/{flipbookId}Verwijdert alleen de genoemde adressen
De hele lijst vervangenPUT /api/set-email-allow-list/{flipbookId}Overschrijft de hele lijst

De huidige lijst lezen

Begin hier altijd — lees de lijst zodat je de exacte staat kent voordat je iets verandert.

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

Response:

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

EmailsAllowed komt terug als een nette JSON-array (geen puntkommastring), en Count is de lengte ervan.

Adressen toevoegen (zonder de rest te wissen)

Wil je nieuwe mensen toegang geven terwijl iedereen die al op de lijst staat behouden blijft, gebruik dan Toevoegen. Dit is aanvullend — het verwijdert niemand.

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'

Response (de volledige, bijgewerkte lijst):

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

Specifieke adressen verwijderen

Wil je de toegang van bepaalde mensen intrekken, gebruik dan Verwijderen. Alleen de adressen die je opgeeft worden verwijderd; alle anderen blijven staan.

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'

Response:

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

De hele lijst vervangen ⚠️

Set overschrijft de hele toegangslijst met precies de adressen die je meestuurt. Dit is het addertje: één enkel adres meesturen wist alle anderen.

# Dit voegt NIET één persoon toe — het maakt de lijst UITSLUITEND deze ene persoon.
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'

Na deze aanroep is alice@corp.com het enige adres dat de flipbook kan bekijken. Gebruik Set alleen wanneer je echt de complete lijst helemaal opnieuw wilt bepalen (bijvoorbeeld om een gloednieuwe flipbook te vullen). Voor de dagelijkse "geef deze persoon toegang / trek die persoon in"-wijzigingen gebruik je in plaats daarvan Toevoegen en Verwijderen.

Om de lijst volledig te wissen, stuur je een lege waarde:

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

Mogelijke fouten

  • Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Controleer of de X-Api-Key-header aanwezig en correct is.
  • Onbekende flipbookId (of een die niet bij je sleutel hoort) → HTTP 200 met { "Result": "ERROR", "Message": "Item not found" }.

Een handige vuistregel: Result: "OK" betekent dat de wijziging is doorgevoerd; Result: "ERROR" betekent van niet — lees het Message-veld voor de reden.

Aanbevolen werkwijze

Voor veilige, voorspelbare wijzigingen:

  1. GET de huidige lijst.
  2. Bepaal wie je toevoegt of verwijdert.
  3. Gebruik Toevoegen / Verwijderen voor gerichte wijzigingen (ze verstoren nooit de rest van de lijst).
  4. Reserveer Set voor wanneer je echt de hele lijst in één keer wilt vervangen.
  5. GET opnieuw om de uiteindelijke staat te bevestigen.

Met deze "lezen → wijzigen → teruglezen"-lus hoef je de lijst nooit in je eigen systeem bij te houden, en wis je nooit per ongeluk de toegang door Set te gebruiken terwijl je Toevoegen bedoelde.

Gerelateerde discussies