Call-to-actions toevoegen aan een flipbook

Wat je kunt doen

De viewer van een flipbook kan call-to-action-knoppen (CTA-knoppen) tonen die lezers naar een plek van jouw keuze leiden. Met drie endpoints configureer je ze via de API:

• Stel de primaire CTA-knop in — het label, de URL, de kleur en of hij wordt getoond.
• Stel de secundaire CTA-knop in — een tweede knop die de velden met het achtervoegsel 2 gebruikt.
• Stel de voorbeeldregels in — bepaal of de CTA verborgen blijft terwijl een lezer in de voorbeeldmodus is.

Voordat je begint

• Een API-sleutel — meegestuurd op elk verzoek als de X-Api-Key-header of als Authorization: Bearer YOUR_API_KEY.
• De flipbookId — de numerieke ID van de flipbook die je wilt configureren (padparameter op alle drie de endpoints). Die wordt teruggegeven door create-by-file / create-by-url (als ID) of door list.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• De request-body is op alle drie de endpoints form-urlencoded (geen JSON) — stuur elk veld met --data-urlencode.

De primaire CTA-knop instellen

Configureert de primaire call-to-action-knop in de viewer (label, URL, kleur). De velden zijn IsCTAButton, CTAButtonText, CTAButtonURL (plus kleurvelden) — niet Text/URL/Position. Een CTAButtonURL-waarde met een mailto:- / tel:-prefix wordt server-side automatisch genormaliseerd.

curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=' \
  --data-urlencode 'CTAButtonColor=' \
  --data-urlencode 'CTAButtonURL=' \
  --data-urlencode 'CTAButtonTextColor='

Response:

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

De secundaire CTA-knop instellen

Configureert de secundaire call-to-action-knop in de viewer. De secundaire knop gebruikt de velden met het achtervoegsel 2 — IsCTAButton2, CTAButtonText2, CTAButtonURL2 (plus de kleurvelden met het achtervoegsel 2).

curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=' \
  --data-urlencode 'CTAButtonColor2=' \
  --data-urlencode 'CTAButtonTextColor2=' \
  --data-urlencode 'CTAButtonURL2='

Response:

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

De voorbeeldregels instellen

Configureert wanneer de call-to-action aan lezers wordt getoond — de voorbeeldgate-regel. Stuur IsCTAHiddenInPreview mee om te bepalen of de CTA verborgen blijft terwijl een lezer in de voorbeeldmodus is.

curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'

Response:

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

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- (of Authorization: Bearer-)header aanwezig en correct is.
• Item-ID niet gevonden of niet in eigendom van je sleutel → HTTP 200 met Message: "Item not found".
• Onbekend of verkeerd gespeld body-veld → HTTP 200 met Message: "Unknown field(s) '…'. Expected: …". Controleer de exacte spelling van de velden nog eens (bijvoorbeeld de velden met het achtervoegsel 2 van de secundaire knop).

Opmerkingen

• Alle drie de endpoints delen dezelfde {flipbookId}-padparameter en dezelfde succesvorm { "Result": "OK", "Message": "Updated successfully" }.
• De primaire en secundaire knop worden onafhankelijk geconfigureerd — het secundaire endpoint accepteert alleen de veldnamen met het achtervoegsel 2.