Portadas, caducidad del enlace y fijado

Qué puedes hacer

Estos cinco endpoints te permiten gestionar las portadas de un flipbook, la caducidad de su enlace y si está fijado — sin tocar el panel:

• Adjuntar portada y/o contraportada desde un archivo PDF subido.
• Adjuntar portada y/o contraportada desde una URL de PDF remota.
• Quitar la envoltura de portada/contraportada, restaurando el flipbook a su PDF principal sin envolver.
• Definir o eliminar una caducidad automática en el flipbook.
• Fijar o desfijar el flipbook para que se ordene al principio de tu panel.

Antes de empezar

• Una clave de API — enviada en el encabezado X-Api-Key, o como Authorization: Bearer YOUR_API_KEY, en cada petición.
• Cada endpoint de aquí recibe el parámetro de ruta {flipbookId} — el ID numérico del flipbook, devuelto por create-by-file / create-by-url (como ID) o por list. Los ejemplos de abajo usan 96216.
• Todas las peticiones van a la URL base https://go.fliplink.me.
• Los endpoints de portada por URL y set-expiry envían un cuerpo form-urlencoded (no JSON). El endpoint de portada por archivo envía multipart form-data (subidas de archivo). Los endpoints de clear y pin no reciben cuerpo.

Definir portada/contraportada desde un archivo

Adjunta portada y/o contraportada desde archivos PDF subidos. Front y Back son opcionales por separado — se requiere al menos uno. Las páginas se vuelven a fusionar con el PDF principal existente.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

Respuesta:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Definir portada/contraportada desde una URL

La variante por URL de lo anterior — adjunta portada/contraportada desde una URL de PDF remota en lugar de un archivo subido. Los campos Front y Back se envían form-urlencoded.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

Respuesta:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Quitar portada/contraportada

Elimina la envoltura de portada/contraportada, restaurando FilePDF al PDF principal sin envolver (MiddlePDF). Es idempotente — un flipbook sin envoltura devuelve OK y no cambia nada. La respuesta incluye la URL de S3 del PDF principal restaurado. Los objetos S3 antiguos fusionados/de portada/de contraportada no se eliminan. No recibe cuerpo.

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{
  "Result": "OK",
  "Message": "Pages updated successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Definir o eliminar la caducidad

Define o elimina la caducidad automática de un flipbook. Envía Days y Hours como enteros. Hours es opcional y toma el valor 0 por defecto. Enviar Days=-1, Hours=0 elimina la caducidad por completo.

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

Respuesta:

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

Para eliminar la caducidad, envía Days=-1:

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=-1' \
  --data-urlencode 'Hours=0'

Fijar o desfijar

Fija o desfija el flipbook (el estado destacado) para que se ordene al principio de tu panel. Es un interruptor y no recibe cuerpo.

curl -X PUT 'https://go.fliplink.me/api/set-pin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

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

Errores posibles

• Clave de API ausente o no válida → HTTP 401. Esto devuelve una página HTML Unauthorized simple — no hay cuerpo JSON. Verifica que el encabezado X-Api-Key esté presente y sea correcto.
• flipbookId desconocido (o uno no perteneciente a tu clave) → HTTP 200 con "Message": "Item not found".
• Definir portada/contraportada (archivo) — PDF no válido → HTTP 200 con "Message": "File is not a valid PDF." cuando el archivo subido no es un PDF legible.
• Definir portada/contraportada (archivo) — archivo demasiado grande → HTTP 413 con "Message": "File exceeds the maximum allowed upload size." cuando la subida supera el tamaño máximo de archivo del plan.
• Definir portada/contraportada (URL) y definir caducidad — campo desconocido → HTTP 200 con "Message": "Unknown field(s) '…'. Expected: …" cuando un campo del cuerpo está mal escrito o no se reconoce.