Organizar flipbooks con carpetas y plantillas

Qué puedes hacer

Estos tres endpoints te permiten mantener tus flipbooks organizados sin tocar el panel:

• Listar tus carpetas, cada una devuelta como un nombre y un GUID de carpeta.
• Asignar un flipbook a una carpeta — las carpetas se crean al momento, y enviar una carpeta vacía saca el flipbook de su carpeta.
• Guardar un flipbook como plantilla reutilizable, o quitarlo de tus plantillas.

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.
• Todas las peticiones van a la URL base https://go.fliplink.me.
• Los dos endpoints de escritura (assign-to-folder y save-as-template) usan 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.
• Esos endpoints de escritura reciben un cuerpo form-urlencoded (no JSON).

Listar tus carpetas

GET /api/list-folders lista tus carpetas, cada una como { Folder (name), URL (a folder GUID) }. Las carpetas se derivan de las asignaciones de flipbooks, así que una carpeta vacía no aparece en la lista.

curl -X GET 'https://go.fliplink.me/api/list-folders' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Asignar un flipbook a una carpeta

PUT /api/assign-to-folder/{flipbookId} mueve el flipbook a una carpeta. Las carpetas se crean al momento — asigna a un nombre de carpeta que aún no existe y se crea automáticamente (no hay una llamada aparte para "crear carpeta"). Los nombres de carpeta pueden contener / (p. ej. Marketing/Q2). Una carpeta existe solo mientras haya al menos un flipbook en ella, así que mover el último flipbook fuera hace que la carpeta desaparezca de list-folders.

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'

Respuesta:

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Para sacar el flipbook de su carpeta, envía un Folder vacío:

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder='

Guardar un flipbook como plantilla

PUT /api/save-as-template/{flipbookId} marca el flipbook como plantilla reutilizable (Status=true) o lo quita de las plantillas (Status=false). Las plantillas aparecen en list-templates y pueden servir de base para nuevos flipbooks. Status toma el valor true por defecto si se omite.

curl -X PUT 'https://go.fliplink.me/api/save-as-template/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'

Respuesta:

{
  "Result": "OK",
  "Message": "Saved as template"
}

Errores posibles

• Clave de API ausente o no válida → HTTP 401. Esto devuelve una página HTML Unauthorized simple — no hay cuerpo JSON.
• ID del ítem no encontrado o no perteneciente a tu clave (assign-to-folder, save-as-template) → HTTP 200 con Message: "Item not found".
• Campo del cuerpo desconocido o mal escrito (assign-to-folder, save-as-template) → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …".

Notas

• El nombre de Folder que asignas es el mismo valor que aparece bajo Folder en list-folders, así que puedes reutilizar un nombre de carpeta existente para agregarle más flipbooks.