Metadatos, URL personalizada y publicación

Qué puedes hacer

Estos cuatro endpoints controlan cómo se presenta un flipbook: su título y sus metadatos SEO, su estado de publicación, su URL para compartir y el aspecto de la experiencia de lectura. Cada uno apunta a un solo flipbook por su {flipbookId}:

• Define el título y los metadatos SEO: Title, Description, TitleColor y la bandera IsPublished.
• Publica o retira sin tocar el título ni la descripción.
• Asígnale un slug personalizado (vanity) para la URL de compartir.
• Configura la apariencia de la página en el visor: profundidad de página y tipo de portada.

Antes de empezar

• 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, devuelto por create-by-file / create-by-url (como ID) o por list. Los cuatro endpoints de abajo lo usan como parámetro de ruta.
• Todas las peticiones van a la URL base https://go.fliplink.me.
• Cada cuerpo de petición aquí es form-urlencoded (no JSON): envía cada campo con --data-urlencode.

Define el título y los metadatos SEO

PUT /api/set-meta/{flipbookId} define el título y los metadatos SEO del flipbook: Title, Description, TitleColor y la bandera IsPublished. Esto sobrescribe Title/Description/TitleColor. Para cambiar solo el estado de publicación, usa set-published (abajo) en su lugar. TitleColor recibe un color hex con la # inicial (por ejemplo #1a1a1a; por defecto #000000) y se guarda tal cual.

curl -X PUT 'https://go.fliplink.me/api/set-meta/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=Spring 2026 Catalog' \
  --data-urlencode 'Description=Our latest product lineup and pricing' \
  --data-urlencode 'IsPublished=true'

Respuesta:

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

Publica o retira

PUT /api/set-published/{flipbookId} cambia SOLO la bandera de publicación, dejando intactos Title/Description/TitleColor (a diferencia de set-meta). Úsalo para (re)publicar un flipbook; por ejemplo, uno que volvió sin publicar de create-by-file. IsPublished es obligatorio: true/1 = publicar, false/0 = retirar.

curl -X PUT 'https://go.fliplink.me/api/set-published/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'

Respuesta:

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

Define una URL personalizada

PUT /api/set-custom-url/{flipbookId} define el slug personalizado (vanity) para la URL de compartir del flipbook mediante el campo CustomURL. El slug debe ser único: un slug en uso devuelve Result: "ERROR" (consulta los errores más abajo).

curl -X PUT 'https://go.fliplink.me/api/set-custom-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=spring-catalog'

Respuesta:

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

Define la apariencia de la página

PUT /api/set-page-appearance/{flipbookId} configura la apariencia de la página en el visor. Este endpoint expone actualmente solo dos campos ajustables: PageDepth (acepta flat, thin o thick) y CoverType (acepta soft o hard). Los valores se guardan literalmente; los ítems más antiguos pueden devolver otros valores (por ejemplo regular, o el numérico 1) al leerse con Get one.

curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'

Respuesta:

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

Errores posibles

Estos errores se aplican a los cuatro endpoints (custom-URL añade uno propio):

• 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 { "Result": "ERROR", "Message": "Item not found" }.
• URL personalizada ya en uso (solo set-custom-url) → HTTP 200 con { "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }.
• Campo del cuerpo desconocido o mal escrito → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …".

Una regla práctica: Result: "OK" significa que el cambio se aplicó; Result: "ERROR" significa que no se aplicó; lee el Message para saber el motivo.

Notas

• set-meta frente a set-published: set-meta sobrescribe Title/Description/TitleColor, así que si solo quieres cambiar el estado de publicación, usa set-published, que deja esos campos intactos.