Imágenes de portada y de vista previa

Marca y contenido

Define el PDF de vista previa que ven los lectores antes de la captura de leads o el pago, y el PDF solo de imágenes que se usa para miniaturas y vistas previas, desde la API.

APIs usadas en esta discusión

¿Hay algo incorrecto o desactualizado en esta guía?

Qué puedes hacer

Dos endpoints de escritura controlan los PDF que sustituyen a un flipbook antes de que un lector obtenga acceso completo:

  • Define el PDF de vista previa que se muestra a los lectores antes de la captura de leads / el pago.
  • Define el PDF de imágenes que se usa para miniaturas y vistas previas.

Cada llamada apunta a un flipbook por su {flipbookId} y devuelve un resultado de éxito sencillo.

Antes de empezar

Necesitarás:

  • Una clave de API, enviada en cada petición como el encabezado X-Api-Key, o como Authorization: Bearer YOUR_API_KEY.
  • El {flipbookId}: el ID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.
  • Todas las peticiones van a la URL base https://go.fliplink.me.

Ambos endpoints reciben un cuerpo form-urlencoded (no JSON).

Define el PDF de vista previa

PUT /api/set-preview-pdf/{flipbookId} define el PDF de vista previa que se muestra a los lectores antes de la captura de leads / el pago. Se borra automáticamente si tanto la captura de leads como el modo de venta están desactivados.

Envía la URL del PDF que quieres usar en PreviewPDF:

  • PreviewPDF: la URL del PDF que se mostrará como vista previa. El valor se guarda tal cual; la API no valida que la URL sea accesible (probado en producción), así que envía una URL de PDF válida y accesible. El valor por defecto está vacío (sin PDF de vista previa).
curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=https://go.fliplink.me/files/preview.pdf'

Respuesta:

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

Define el PDF de imágenes

PUT /api/set-image-pdf/{flipbookId} define el PDF solo de imágenes/vista previa que se usa para miniaturas y vistas previas. Envía la URL del PDF que quieres usar en IMGPdf:

  • IMGPdf: la URL del PDF solo de imágenes que se usará para miniaturas y vistas previas. El valor se guarda tal cual; la API no valida que la URL sea accesible (probado en producción), así que envía una URL de PDF válida y accesible. El valor por defecto es un marcador sin imagen, y enviar un valor vacío mantiene el PDF de imágenes existente.
curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=https://go.fliplink.me/files/pages.pdf'

Respuesta:

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

Errores posibles

  • Clave de API ausente o no válida → HTTP 401. Devuelve una página HTML de "Unauthorized" 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: ….

Notas

  • Para ambos campos, el valor de la URL se guarda tal cual: la API no comprueba que el PDF sea accesible (probado en producción). Envía siempre una URL de PDF válida y accesible.
  • El PDF de vista previa (PreviewPDF) tiene por defecto un valor vacío y se borra automáticamente si tanto la captura de leads como el modo de venta están desactivados.
  • El PDF de imágenes (IMGPdf) tiene por defecto un marcador sin imagen; enviar un valor vacío mantiene el PDF de imágenes existente.

Discusiones relacionadas