Obtener flipbooks y sus detalles

Flipbooks

Lee tus flipbooks a través de la API — obtén un solo registro por ID, busca uno por su URL pública, recorre toda tu biblioteca con paginación y obtén sus enlaces de PDF y de visor.

APIs usadas en esta discusión

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

Qué puedes hacer

Estos cinco endpoints de solo lectura cubren todas las formas en que querrás leer un flipbook desde FlipLink — ya sea que tengas su ID numérico, solo su URL pública, o nada más que las ganas de recorrer todo lo que tienes:

Get one — el registro completo de un flipbook por su flipbookId.
Find by URL — busca un flipbook a partir de su URL pública o de compartición.
List — lista tus flipbooks/documentos con paginación.
Get the PDF URL — el enlace público de S3 al PDF principal de un elemento.
Get the share link — la URL pública del visor de un elemento.

Antes de empezar

Una clave de API — enviada en cada solicitud, ya sea en el encabezado X-Api-Key o como Authorization: Bearer YOUR_API_KEY.
Todas las solicitudes van a la URL base https://go.fliplink.me.
Tres de estos endpoints reciben un parámetro de ruta {flipbookId} — el ID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por List. Los otros dos (Find by URL, List) reciben parámetros de query string en su lugar.
Las cinco son solicitudes GET y no envían cuerpo.

Obtener un flipbook

GET /api/get/{flipbookId} devuelve el registro completo de un solo flipbook/documento por ID — cada columna almacenada: título, URLs, recuentos de vistas/leads/ventas, carpeta y banderas de estado. El registro completo se devuelve envuelto en un objeto Item con ~190 columnas; el ejemplo de abajo es un subconjunto abreviado y representativo.

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

Respuesta:

{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "Name": "My Document",
    "Title": "My Title",
    "DocType": "Flipbook",
    "IsPublished": true,
    "Pages": 8,
    "Folder": "Marketing",
    "SkinName": "Light Wood",
    "CustomURL": "my-document-96216",
    "ValidTillDate": "",
    "NoOfViews": 42,
    "NoOfLeads": 3,
    "NoOfSales": 0,
    "IsForSale": false,
    "IsLeadCapture": true,
    "IsPasswordProtected": false,
    "BookLayout": 1,
    "ScrollBehaviour": 1,
    "IsRightToLeft": false,
    "CoverType": "1",
    "PageDepth": "1",
    "FullURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172",
    "EmbedURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172"
  }
}

Buscar un flipbook por URL

GET /api/find-by-url busca un flipbook por su URL pública o de compartición y devuelve su registro completo (con la misma forma que Get one). Pasa la URL completa del visor, una URL de CNAME o solo el slug CustomURL en el parámetro de consulta URL — el servidor toma el último segmento de la ruta como slug.

curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https://go.fliplink.me/view/your-flipbook-slug' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta (abreviada — el registro completo tiene ~190 columnas):

{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "VendorID": "20000",
    "FilePDF": "/docs/20001/894abc58~demo_multipage.pdf",
    "Name": " coverage 20-Jun",
    "CreatedOn": "/Date(1781945608053)/",
    "NoOfViews": 1,
    "IsActive": true,
    "CustomURL": "your-flipbook-slug",
    "Title": "",
    "Description": " desc",
    "Pages": 8,
    "Folder": "-Folder",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsPublished": true,
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

Listar tus flipbooks

GET /api/list lista tus flipbooks/documentos con paginación (PageNo/PageSize). Cada elemento incluye IDs, título, URLs, recuentos de vistas/leads/ventas, carpeta y banderas de estado. También puedes filtrar con Folder y SearchText, paginar con PageNo, PageSize y Offset, y ordenar con SortBy y SortOrder.

SortBy acepta uno de Name, DocType, CreatedOn, NoOfViews, NoOfLeads (vacío = orden por defecto; los valores desconocidos vuelven al orden por defecto). SortOrder es ASC o DESC — se ignora si SortBy está vacío, y los valores desconocidos vuelven en silencio al valor por defecto.

curl -X GET 'https://go.fliplink.me/api/list?Folder=&SearchText=&PageNo=1&PageSize=25&Offset=0&SortBy=&SortOrder=' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{
  "Result": "OK",
  "Items": [
    {
      "ID": 93286,
      "Name": "INSPECT matrix Document - Copy 000",
      "Title": "MX Title",
      "CreatedOn": "Jun 12 2026  4:48PM",
      "CreatedOnIso": "2026-06-12T22:18:49.723+05:30",
      "CreatedDate": "Jun 12, 2026",
      "CreatedTime": " 4:48PM",
      "ValidTillDate": "",
      "NoOfViews": 0,
      "CustomURL": "0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "Password": "",
      "FilePDF": "/docs/20001/0DF318DC~dummy.pdf",
      "NoOfLeads": 0,
      "NoOfSales": 0,
      "FullURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "EmbedURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "IMGPdf": "/Content/assets/media/users/no-image.png",
      "Pages": 0,
      "IsUnpublished": "",
      "Folder": "",
      "IsTemplate": false,
      "CNAMEMessage": "",
      "DocType": "Document",
      "DocTypeColor": "danger",
      "SSL": "No",
      "CompressDataKey": "",
      "Optimised": "",
      "IsPinnedThumbnails": true,
      "IsApprovalButton": true,
      "NoOfApprovals": 0,
      "FrontPDF": "/docs/20001/730d7569~dummy.pdf",
      "MiddlePDF": "/docs/20001/4b34cbea~dummy.pdf",
      "BackPDF": "/docs/20001/e4454ad1~dummy.pdf"
    }
  ],
  "TotalRecordCount": 14,
  "TotalItems": 14,
  "UserItems": 14,
  "PageSize": 10,
  "Capped": false
}

Obtener la URL del PDF de un flipbook

GET /api/get-pdf/{flipbookId} devuelve la URL pública de S3 del PDF principal del elemento (versión combinada si tiene portada/contraportada envueltas).

curl -X GET 'https://go.fliplink.me/api/get-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

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

Obtener el enlace de compartición de un flipbook

GET /api/get-share-link/{flipbookId} devuelve la URL pública del visor del flipbook (su prefijo de dominio personalizado/host más el slug de compartición del flipbook).

curl -X GET 'https://go.fliplink.me/api/get-share-link/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{
  "Result": "OK",
  "URL": "https://go.fliplink.me/view/your-flipbook-slug"
}

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. Esto aplica a los cinco endpoints.
flipbookId desconocido (o uno que no pertenece a tu clave) → HTTP 200, mensaje Item not found. Esto aplica a Get one, Get PDF URL y Get Share Link.

Notas

Get one y Find by URL devuelven la misma forma de registro completo envuelta en un objeto Item.
List envuelve sus resultados en un array Items e incluye campos de paginación (TotalRecordCount, TotalItems, UserItems, PageSize, Capped).
Get PDF URL y Get Share Link devuelven cada uno un único campo URL junto con Result.

Discusiones relacionadas

Portadas, caducidad del enlace y fijado Crear un flipbook (desde un PDF o una URL)Eliminar un flipbook Organizar flipbooks con carpetas y plantillas Reemplazar el PDF de un flipbook y duplicarlo