Aggiungere inviti all'azione a un flipbook

Cosa puoi fare

Il viewer di un flipbook può mostrare pulsanti di invito all'azione (CTA) che indirizzano i lettori dove scegli tu. Tre endpoint ti permettono di configurarli dall'API:

• Impostare il pulsante CTA primario — la sua etichetta, l'URL, il colore e se viene mostrato.
• Impostare il pulsante CTA secondario — un secondo pulsante che usa i campi con suffisso 2.
• Impostare le regole di anteprima — controllare se la CTA viene nascosta mentre un lettore è in anteprima.

Prima di iniziare

• Una chiave API — inviata come header X-Api-Key o come Authorization: Bearer YOUR_API_KEY in ogni richiesta.
• Il flipbookId — l'ID numerico del flipbook che vuoi configurare (parametro nel percorso in tutti e tre gli endpoint). Viene restituito da create-by-file / create-by-url (come ID) o da list.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• Il body della richiesta è form-urlencoded (non JSON) in tutti e tre gli endpoint — invia ogni campo con --data-urlencode.

Impostare il pulsante CTA primario

Configura il pulsante di invito all'azione primario nel viewer (etichetta, URL, colore). I campi sono IsCTAButton, CTAButtonText, CTAButtonURL (più i campi dei colori) — non Text/URL/Position. Un valore di CTAButtonURL con un prefisso mailto: / tel: viene normalizzato automaticamente lato server.

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='

Risposta:

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

Impostare il pulsante CTA secondario

Configura il pulsante di invito all'azione secondario nel viewer. Il pulsante secondario usa i campi con suffisso 2 — IsCTAButton2, CTAButtonText2, CTAButtonURL2 (più i campi dei colori con suffisso 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='

Risposta:

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

Impostare le regole di anteprima

Configura quando l'invito all'azione viene mostrato ai lettori — la regola della barriera di anteprima. Invia IsCTAHiddenInPreview per controllare se la CTA viene nascosta mentre un lettore è in anteprima.

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

Risposta:

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

Errori possibili

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key (o Authorization: Bearer) sia presente e corretto.
• ID dell'elemento non trovato o non di proprietà della tua chiave → HTTP 200 con Message: "Item not found".
• Campo del body sconosciuto o scritto male → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …". Ricontrolla l'esatta ortografia dei campi (per esempio, i campi con suffisso 2 del pulsante secondario).

Note

• Tutti e tre gli endpoint condividono lo stesso parametro {flipbookId} nel percorso e la stessa forma di successo { "Result": "OK", "Message": "Updated successfully" }.
• Il pulsante primario e quello secondario si configurano in modo indipendente — l'endpoint secondario accetta solo i nomi dei campi con suffisso 2.