Añadir llamadas a la acción a un flipbook

Qué puedes hacer

El visor de un flipbook puede mostrar botones de llamada a la acción (CTA) que llevan a los lectores adonde tú elijas. Tres endpoints te permiten configurarlos desde la API:

• Configura el botón de CTA principal — su etiqueta, URL, color y si se muestra.
• Configura el botón de CTA secundario — un segundo botón que usa los campos con sufijo 2.
• Configura las reglas de vista previa — controla si la CTA se oculta mientras un lector está en la vista previa.

Antes de empezar

• Una clave de API — enviada como el encabezado X-Api-Key o como Authorization: Bearer YOUR_API_KEY en cada solicitud.
• El flipbookId — el ID numérico del flipbook que quieres configurar (parámetro de ruta en los tres endpoints). Lo devuelven create-by-file / create-by-url (como ID) o list.
• Todas las solicitudes van a la URL base https://go.fliplink.me.
• El cuerpo de la solicitud es form-urlencoded (no JSON) en los tres endpoints — envía cada campo con --data-urlencode.

Configura el botón de CTA principal

Configura el botón de llamada a la acción principal en el visor (etiqueta, URL, color). Los campos son IsCTAButton, CTAButtonText, CTAButtonURL (además de los campos de color) — no Text/URL/Position. Un valor de CTAButtonURL con un prefijo mailto: / tel: se normaliza automáticamente en el servidor.

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

Respuesta:

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

Configura el botón de CTA secundario

Configura el botón de llamada a la acción secundario en el visor. El botón secundario usa los campos con sufijo 2 — IsCTAButton2, CTAButtonText2, CTAButtonURL2 (además de los campos de color con sufijo 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='

Respuesta:

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

Configura las reglas de vista previa

Configura cuándo se muestra la llamada a la acción a los lectores — la regla de la puerta de vista previa. Envía IsCTAHiddenInPreview para controlar si la CTA se oculta mientras un lector está en la vista previa.

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

Respuesta:

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

Errores posibles

• Clave de API ausente o no válida → HTTP 401. Esto devuelve una página HTML de "Unauthorized" sin formato sin formato — no hay cuerpo JSON. Comprueba que el encabezado X-Api-Key (o Authorization: Bearer) esté presente y sea correcto.
• ID del ítem no encontrado o no perteneciente a tu clave → HTTP 200 con Message: "Item not found".
• Campo del cuerpo desconocido o mal escrito → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …". Verifica la ortografía exacta del campo (por ejemplo, los campos con sufijo 2 del botón secundario).

Notas

• Los tres endpoints comparten el mismo parámetro de ruta {flipbookId} y la misma forma de éxito { "Result": "OK", "Message": "Updated successfully" }.
• Los botones principal y secundario se configuran de forma independiente — el endpoint secundario solo acepta los nombres de campo con sufijo 2.