API para desarrolladores · REST

Referencia de la API de FlipLink

Crea flipbooks y documentos, configura el visor, capta leads y gestiona dominios personalizados, todo de forma programática. Autentícate con tu API key y prueba cada endpoint en vivo, directamente desde esta página.

Base URL https://go.fliplink.me

Consigue una clave →

Introducción

La API REST de FlipLink te permite crear y gestionar flipbooks y documentos de forma programática: subir PDFs, configurar el visor, captar leads, gestionar dominios personalizados y mucho más. Cada endpoint está disponible bajo la base URL de abajo y se autentica con tu API key.

Base URL
https://go.fliplink.me

Autenticación

Envía tu API key en cada petición. Se admiten dos estilos de cabecera; usa el que prefiera tu cliente HTTP:

Cabeceras de autenticación
X-Api-Key: YOUR_API_KEY
# — or —
Authorization: Bearer YOUR_API_KEY

Una clave que falte o no sea válida se rechaza con HTTP 401 (una página HTML de “Unauthorized”: no hay cuerpo JSON, así que no intentes analizar uno en un 401). Una vez que la clave es válida, cualquier otro error llega como HTTP 200 con Result: ERROR (ver más abajo). Mantén tu clave en secreto: nunca la expongas en código de cliente que entregues a los usuarios finales.

Formato de respuesta y tipos de resultado

Todas las respuestas son JSON y llevan un campo Result de primer nivel; hay exactamente dos valores:

  • "Result": "OK": éxito. Los endpoints de lectura añaden su carga útil; los de escritura añaden un Message legible (p. ej. "Updated successfully") y create/duplicate devuelven el nuevo ID y la URL.
  • "Result": "ERROR": fallo, con un Message que explica el motivo.

Importante: solo los fallos de autenticación (401), las subidas demasiado grandes (413) y el límite de uso (429) usan un código HTTP distinto de 200. Todo lo demás —validación, “no encontrado”, reglas de negocio— devuelve HTTP 200 con Result: ERROR, así que comprueba Result, no solo el código de estado.

Paginación

Los endpoints de listado aceptan los parámetros de consulta PageNo, PageSize y Offset. Omítelos para usar valores por defecto razonables.

Límites de uso

Cada API key está limitada a 300 peticiones por minuto. La ventana es fija y se reinicia al cambiar de minuto en el reloj (no son 60 segundos rodantes). Cada respuesta lleva el saldo actual en sus cabeceras:

Cabeceras de límite de uso
X-RateLimit-Limit: 300          # requests allowed per minute
X-RateLimit-Remaining: 287      # requests left in the current window
X-RateLimit-Reset: 1781962140   # Unix epoch (seconds) when the window resets

Cuando superas el límite, obtienes HTTP 429. Espera hasta X-RateLimit-Reset (o aplica una espera y reintenta) y vigila X-RateLimit-Remaining para no pasarte del tope.

Límites y cuotas del plan

Tu cuota de flipbooks se devuelve en las respuestas de create y en get-subscription-details como Flipbooks_Count / Flipbooks_Max / Flipbooks_Left. El tamaño máximo de subida se expone como MaxFileSizeMB.

Errores

Condiciones habituales que conviene manejar (cada endpoint enumera las suyas más abajo):

  • 401: API key ausente o no válida (página HTML, sin JSON)
  • 413: la subida supera el tamaño máximo de archivo del plan
  • 429: límite de uso alcanzado; aplica una espera y reintenta
  • 200 + Result:ERROR: todo lo demás: no encontrado ("Item not found"), validación ("Unknown field(s) …") o una regla de negocio ("This custom URL is already in use…", "File is not a valid PDF")

Perfil

Quién soy

Devuelve la cuenta propietaria de la API key: los IDs de usuario/proveedor, el nombre, el correo, la marca, la URL de la app y el tamaño máximo de subida del plan (MaxFileSizeMB).

GEThttps://go.fliplink.me/api/whoami

Requisitos previos — ninguno. Esta es la llamada raíz: autentica tu API key, el requisito previo de cualquier otro endpoint.

Sin parámetros.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/whoami
curl -X GET 'https://go.fliplink.me/api/whoami' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Obtener perfil

Devuelve el perfil de la cuenta asociada a la API key: nombre visible, teléfono y URL de la imagen de perfil.

GEThttps://go.fliplink.me/api/get-profile
Requisitos previosQuién soy(una API key válida)Obtener perfil

Sin parámetros.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/get-profile
curl -X GET 'https://go.fliplink.me/api/get-profile' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Definir perfil (parcial)

Actualización parcial: los campos que omitas conservan su valor actual. Hace falta al menos un campo.

PUThttps://go.fliplink.me/api/set-profile
Requisitos previosQuién soy(una API key válida)Definir perfil (parcial)

Parámetros del cuerpo

Namep. ej. Mark Stevens
Phonephonep. ej. +14155550142
ProfileImageURLp. ej. https://...

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

RelacionadosObtener perfil
PUT/api/set-profile
curl -X PUT 'https://go.fliplink.me/api/set-profile' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Mark Stevens' \
  --data-urlencode 'Phone=+14155550142' \
  --data-urlencode 'ProfileImage=https://...'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros del cuerpo

Suscripción y pagos

Obtener detalles de la suscripción

Devuelve tu plan y tu cuota actuales: nombre del plan, estado, tarifas, fecha de la próxima factura, tamaño máximo de archivo, máximo de elementos/CNAMEs y las feature flags.

GEThttps://go.fliplink.me/api/get-subscription-details
Requisitos previosQuién soy(una API key válida)Obtener detalles de la suscripción

Sin parámetros.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/get-subscription-details
curl -X GET 'https://go.fliplink.me/api/get-subscription-details' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Subscription": {
    "BrandName": "",
    "Name": "Your Account",
    "Mobile": "",
    "SubscriptionPlan": "LTD Individual",
    "SubscriptionFees": "USD 39.00",
    "Tax": "",
    "SubscriptionID": "#20000",
    "ActiveFrom": "12 Jun 2026",
    "Status": "Active",
    "NextInvoice": "01 Jan 2050",
    "Email": "you@example.com",
    "PhotoIMG": "/Content/assetsNew/media/avatars/blank.png",
    "MaxFileSizeBytes": 157286400,
    "MaxFileSize": "150",
    "MaxCNAME": "Unlimited",
    "AdvancedSharing": "Yes",
    "LeadEmailVerification": "Yes",
    "IsLTD": "Yes",
    "MaxItems": "200"
  }
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Listar pagos

Devuelve tu historial de facturación: cada compra/renovación de plan con su order ID, importe, plan, fecha y número de elementos.

GEThttps://go.fliplink.me/api/list-payments
Requisitos previosQuién soy(una API key válida)Listar pagos

Sin parámetros.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-payments
curl -X GET 'https://go.fliplink.me/api/list-payments' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [
    {
      "OrderID": "#10001",
      "Amount": "USD 39.00",
      "Plan": "LTD Individual / 822bf1b6",
      "Date": "12 Jun 2026",
      "DateIso": "2026-06-12T00:00:00+05:30",
      "InvoiceURL": "",
      "ItemCount": 100
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Elementos — Crear

Crear desde un archivo

Crea un flipbook (o documento) a partir de un PDF subido, enviado como multipart/form-data. El archivo se almacena, se genera una miniatura y se registra el elemento.

Notas
- Que obtengas un Flipbook o un Document depende de la cabecera Host de la petición: go.fliplink.me (por defecto) devuelve Flipbooks y go.doclink.me devuelve Documents.
- *_Count / *_Max / *_Left reflejan la cuota de tu plan después de esta creación.
- Usa el ID devuelto para las llamadas siguientes (set-meta, set-cta-primary, save-as-template, etc.).
- El tamaño máximo de archivo depende de cada plan (consulta MaxFileSizeMB en who-am-i).

POSThttps://go.fliplink.me/api/create-by-file
Requisitos previosQuién soy(una API key válida)Crear desde un archivo

Cuerpo (multipart/form-data)

Filefile
Namep. ej. My Document
Titlep. ej. My Title
DocTypeenumFlipbook o Document. En go.doclink.me siempre se trata como Document.Uno de: Flipbook, Document

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

POST/api/create-by-file
curl -X POST 'https://go.fliplink.me/api/create-by-file' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file' \
  -F 'Name=My Document' \
  -F 'Title=My Title' \
  -F 'DocType=Flipbook'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Cuerpo (form-data)

Crear desde una URL

Crea un flipbook (o documento) a partir de la URL de un PDF. El servidor descarga FileURL, lo sube a S3, genera una miniatura y registra el elemento.

Notas
- El prefijo del nombre de campo Flipbooks_* o Documents_* depende de la cabecera Host de la petición: go.fliplink.me (por defecto) devuelve Flipbooks y go.doclink.me devuelve Documents.
- *_Count / *_Max / *_Left reflejan la cuota del plan de la cuenta después de esta creación.
- La URL de origen debe responder en menos de 60 s: las fuentes lentas o inaccesibles fallan con Source URL timed out after 60s. Para fuentes poco fiables, usa mejor /api/create-by-file.

POSThttps://go.fliplink.me/api/create-by-url
Requisitos previosQuién soy(una API key válida)Crear desde una URL

Parámetros del cuerpo

FileURLURLp. ej. https://example.com/document.pdf
Namep. ej. My Document
Titlep. ej. My Title
DocTypeenump. ej. FlipbookUno de: Flipbook, Document

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200FileURL host is private / not allowed{ "Result": "ERROR", "Message": "FileURL host is not allowed." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

POST/api/create-by-url
curl -X POST 'https://go.fliplink.me/api/create-by-url' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FileURL=https://example.com/document.pdf' \
  --data-urlencode 'Name=My Document' \
  --data-urlencode 'Title=My Title' \
  --data-urlencode 'DocType=Flipbook'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros del cuerpo

Elementos — Leer

Obtener uno

Devuelve el registro completo de un único flipbook/documento por su ID: todas las columnas almacenadas, como el título, las URLs, los recuentos de vistas/leads/ventas, la carpeta y los flags de estado. El registro completo se devuelve envuelto en un objeto `Item` con unas 190 columnas; el ejemplo de abajo es un subconjunto abreviado y representativo.

GEThttps://go.fliplink.me/api/get/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Obtener uno

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/get/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "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"
  }
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Buscar por URL

Busca un flipbook por su URL pública/de compartir y devuelve su registro completo (con la misma forma que get).

GEThttps://go.fliplink.me/api/find-by-url
Requisitos previosQuién soy(una API key válida)Buscar por URL

Parámetros de consulta

URLURLLa URL completa del visor, una URL de CNAME o simplemente el slug de CustomURL a secas. El servidor toma el último segmento de la ruta como slug.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/find-by-url
curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https%3A%2F%2Fgo.fliplink.me%2Fview%2F%3Cslug%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "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",
    "SkinID": -1,
    "LogoIMG": "",
    "LogoURL": "https://fliplink.me",
    "BackgroundIMG": "",
    "BackgroundDisplayFit": "",
    "BackgroundFillDirection": "",
    "ColorPanel": "#5A5F63",
    "ColorBackground": "#F2F2F2",
    "ColorLink": "#75869C",
    "FaviconIMG": "",
    "IsShare": true,
    "IsPrint": true,
    "IsDownload": false,
    "IsTextSelection": true,
    "IsThumbnails": true,
    "IsSound": false,
    "IsFullscreen": false,
    "IsZoom": false,
    "IsSearch": true,
    "IsPinnedThumbnails": false,
    "IsCTAButton": false,
    "CTAButtonText": "Buy",
    "CTAButtonColor": "#3366FF",
    "CTAButtonTextColor": "       ",
    "CTAButtonURL": "https://fliplink.me",
    "IsPasswordProtected": false,
    "Password": "",
    "IsLeadCapture": true,
    "LeadCaptureTitle": "",
    "IsLeadEmail": true,
    "IsLeadEmailMandatory": true,
    "IsLeadName": true,
    "IsLeadNameMandatory": false,
    "IsLeadPhone": false,
    "IsLeadPhoneMandatory": false,
    "IsLeadCompany": false,
    "IsLeadCompanyMandatory": false,
    "IsLeadDate": false,
    "IsLeadDateMandatory": false,
    "IsLeadCustom1": false,
    "IsLeadCustom1Mandatory": false,
    "Custom1Label": "",
    "IsLeadCustom2": false,
    "IsLeadCustom2Mandatory": false,
    "Custom2Label": "",
    "IsLeadPrivacyPolicy": false,
    "PrivacyPolicyURL": "",
    "IsLeadAllowSkip": true,
    "PageTurnMode": "Flip",
    "BookLayout": 1,
    "Shadowdepth": 1,
    "IsFixedZoomMode": false,
    "IsHardCover": false,
    "IsBookThickness": true,
    "IsLinkHighlight": true,
    "IsRightToLeft": false,
    "IMGPdf": "/Content/assets/media/users/no-image.png",
    "Pages": 8,
    "FacebookAnalyticsCode": "",
    "GoogleAnalyticsCode": "",
    "GoogleTagManager": "",
    "Folder": "-Folder",
    "PabblyWebhookURL_NewLead": "https://example.com/webhook-apitest",
    "TitleColor": "#3366FF",
    "CNAME": "",
    "IsNoIndex": false,
    "BackgroundMusic": "",
    "BackgroundMusicCustom": "",
    "AutoFlipInSecs": 0,
    "PwdTitle": "This is a private flipbook.\r\nTo view it, please enter the password.",
    "PwdPlaceholder": "Password",
    "PwdButton": "Submit",
    "LeadEmail": "Email",
    "LeadName": "Name",
    "LeadPhone": "Phone",
    "LeadCompany": "Company",
    "LeadDate": "Date",
    "LeadButton": "Submit",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsSendEmailOnView": false,
    "LeadFormAfterPages": 0,
    "CustomLoadingText": " loading",
    "IsShareButtons": true,
    "IsNotes": false,
    "IsCTAButton2": false,
    "CTAButtonText2": "More",
    "CTAButtonColor2": "#3366FF",
    "CTAButtonTextColor2": "       ",
    "CTAButtonURL2": "",
    "IsVerifyEmail": false,
    "IsVerifyMobile": false,
    "TwillioAPIKey": "",
    "IsShowControls": true,
    "NotificationsEmail": "antifragiletech@gmail.com",
    "GoogleSheetURL": "",
    "GoogleSheetIDKey": "",
    "GoogleSheetName": "",
    "PrivacyPolicyText": "",
    "PageDepth": "1",
    "CoverType": "1",
    "IsPublished": true,
    "LeadPhoneCountry": "",
    "LeadAfterPages": 0,
    "EmailsAllowed": "",
    "EmailVerifyTitleText": "antifragiletech@gmail.com",
    "EmailVerifyButtonText": "antifragiletech@gmail.com",
    "LeadSkipText": "",
    "OrdPos": 1,
    "IsStarred": false,
    "IsShowLogoMobile": true,
    "PreviewPDF": "",
    "IsForSale": false,
    "SaleCurr": "USD",
    "SaleAmount": 10,
    "SalePageTitle": "",
    "SaleAccessPageTitle": "",
    "SalePurchaseButtonText": "",
    "SaleButtonText": "",
    "SaleAccessButtonText": "",
    "SaleButtonColor": "#3366FF",
    "SaleGatewayName": "",
    "SaleGatewayKey": "",
    "SaleGatewaySecret": "",
    "EmailLeadSubject": "",
    "EmailLeadBody": " body",
    "EmailViewSubject": "antifragiletech@gmail.com",
    "EmailViewBody": "antifragiletech@gmail.com",
    "EmailSaleSubject": "antifragiletech@gmail.com",
    "EmailSaleBody": "antifragiletech@gmail.com",
    "TopLeft": "",
    "TopRight": "",
    "BottomLeft": "",
    "BottomRight": "",
    "IsCTAHiddenInPreview": false,
    "IsApprovalButton": false,
    "ApprovalButtonText": "Approve Document",
    "ApprovalButtonColor": "#000000",
    "ApprovalButtonTextColor": "#FFFFFF",
    "EmailApproveRequestSubject": "Document Approval Request: ##DOCUMENT_TITLE##",
    "EmailApproveRequestBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveRemindSubject": "Pending Document Approval: ##DOCUMENT_TITLE##",
    "EmailApproveRemindBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveSubmitSubject": "Document Approved: ##DOCUMENT_TITLE##",
    "EmailApproveSubmitBody": "<p>Hi,</p>\n<p>We are pleased to inform you that the following document has been approved:</p>\n<p>Name: <strong>##DOCU...",
    "IsBackgroundMusicLoop": false,
    "IsNavFirstLast": true,
    "IsShareFacebook": true,
    "IsShareTwitter": true,
    "IsShareWhatsApp": true,
    "IsShareTelegram": false,
    "IsShareLinkedIn": false,
    "IsSharePinterest": false,
    "IsShareReddit": false,
    "IsShareTumblr": false,
    "IsShareMessenger": false,
    "IsShareEmail": false,
    "IsShareLine": false,
    "IsShareWeChat": false,
    "IsShareInstagram": false,
    "IsShareFlipboard": false,
    "IsShareGeneral": false,
    "ScrollBehaviour": 1,
    "AIProvider": "",
    "AIKey": "",
    "IsVA": false,
    "VAButtonText": "",
    "VAButtonColor": "#3366FF",
    "VAButtonTextColor": "#3366FF",
    "VAText": "",
    "VAEmbeddings": "",
    "VAButtonStatus1": "0",
    "VAButtonStatus2": "0",
    "VAButtonStatus3": "0",
    "VAButtonStatus4": "0",
    "FrontPDF": "/docs/20001/f9496e75~dummy.pdf",
    "MiddlePDF": "/docs/20001/0b14ad4d~demo_multipage.pdf",
    "BackPDF": "/docs/20001/68504e6d~dummy.pdf",
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "WebhookURL_NewLead": "https://example.com/webhook-apitest",
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Listar

Lista tus flipbooks/documentos con paginación (PageNo/PageSize). Cada elemento incluye los IDs, el título, las URLs, los recuentos de vistas/leads/ventas, la carpeta y los flags de estado.

GEThttps://go.fliplink.me/api/list
Requisitos previosQuién soy(una API key válida)Listar

Parámetros de consulta

Folder
SearchText
PageNonumberp. ej. 1
PageSizenumberp. ej. 25
Offsetnumberp. ej. 0
SortByenumOpcional. Uno de: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Vacío = orden por defecto; los valores desconocidos vuelven al orden por defecto.Uno de: Name, DocType, CreatedOn, NoOfViews, NoOfLeads
SortOrderenumOpcional. `ASC` o `DESC`. Se ignora si SortBy está vacío. Los valores desconocidos vuelven en silencio al valor por defecto.Uno de: ASC, DESC

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list
curl -X GET 'https://go.fliplink.me/api/list?Folder=%3CFolder%3E&SearchText=%3CSearchText%3E&PageNo=1&PageSize=25&Offset=0&SortBy=%3CSortBy%3E&SortOrder=%3CSortOrder%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "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
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Obtener la URL del PDF

Devuelve la URL pública de S3 del PDF principal del elemento (la versión combinada si tiene portada/contraportada envueltas).

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Obtener la URL del PDF

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/get-pdf/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Elementos — Modificar

Duplicar

Crea una o varias copias de un flipbook en el servidor: cada copia recibe su propio ID y URL de compartir. Puedes duplicar hasta 20 a la vez (Count).

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Duplicar

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

Countnumber1–500 (el servidor lo ajusta al rango)

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

POST/api/duplicate/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/duplicate/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Count=3'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Reemplazar PDF (archivo)

Subida multipart. Vuelve a combinar automáticamente con la portada/contraportada existentes si las hay.

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Reemplazar PDF (archivo)

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Cuerpo (multipart/form-data)

Filefile

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/replace-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Cuerpo (form-data)

Reemplazar PDF (URL)

Reemplaza el PDF de un flipbook existente por uno que el servidor descarga de la URL que le indiques. El flipbook conserva su ID, su configuración y su enlace para compartir.

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Reemplazar PDF (URL)

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

FileURLp. ej. https://example.com/new.pdf

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/replace-pdf-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'File=https://example.com/new.pdf'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Guardar como plantilla (alternar)

Marca el flipbook como una plantilla reutilizable (Status=true) o lo quita de las plantillas (Status=false). Las plantillas aparecen en list-templates y sirven de punto de partida para nuevos flipbooks.

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Guardar como plantilla (alternar)

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

Statustrue | falsetrue/false. Por defecto true si se omite.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/save-as-template/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/save-as-template/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Saved as template"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Asignar a una carpeta

Mueve el flipbook a una carpeta para organizarlo. Las carpetas se crean al vuelo: si asignas un nombre de carpeta que aún no existe, se crea automáticamente (no hay una llamada aparte para «crear carpeta»). Envía un Folder vacío para sacar el flipbook de su carpeta. Una carpeta existe solo mientras tenga al menos un flipbook dentro, así que mover el último flipbook fuera hace que la carpeta desaparezca de list-folders. Los nombres de carpeta pueden contener / (p. ej. Marketing/Q2).

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Asignar a una carpeta

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

FolderNombre de la carpeta a la que mover el flipbook; se crea si no existe (o reutiliza un nombre de list-folders). Envíalo vacío para quitar la asignación.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/assign-to-folder/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir portada/contraportada (archivo)

Front o Back, cualquiera de los dos es opcional, pero hace falta al menos uno. Vuelve a combinar con el PDF principal existente.

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir portada/contraportada (archivo)

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Cuerpo (multipart/form-data)

Frontfile
Backfile

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Cuerpo (form-data)

Definir portada/contraportada (URL)

Variante por URL de set-front-back-page: añade las páginas de portada/contraportada desde la URL de un PDF remoto en lugar de un archivo subido.

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir portada/contraportada (URL)

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

FrontURLp. ej. https://example.com/front.pdf
BackURLp. ej. https://example.com/back.pdf

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-front-back-page-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Quitar portada/contraportada

Elimina la envoltura de portada/contraportada y restaura FilePDF al PDF central sin envolver (MiddlePDF). Es idempotente: un flipbook sin envoltura devuelve OK y no cambia nada. Devuelve { Result, Message, URL (la URL de S3 del PDF central) }. Los objetos de S3 combinados/de portada/de contraportada antiguos no se eliminan.

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Quitar portada/contraportada

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/clear-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Definir/quitar caducidad

Define o quita la caducidad automática de un flipbook. Envía Days y Hours como enteros; Days=-1, Hours=0 elimina la caducidad por completo.

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir/quitar caducidad

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

DaysnumberUsa -1 para quitar la caducidad
HoursnumberOpcional, por defecto 0

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-expiry/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-expiry/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Fijar (alternar)

Fija o quita la fijación del flipbook (el estado destacado) para que se ordene arriba del todo en tu panel.

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Fijar (alternar)

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

RelacionadosListar
PUT/api/set-pin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Elementos — Eliminar

Eliminar

Elimina de forma permanente el registro del flipbook en la base de datos. Nota: los archivos de S3 subyacentes NO se eliminan automáticamente.

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Eliminar

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

DELETE/api/delete/{flipbookId}
curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

CNAME (dominios personalizados)

Añadir CNAME

Vincula a un flipbook un dominio personalizado (CNAME) ya activado. El dominio debe añadirse y verificarse antes desde el panel web (que aprovisiona DNS + SSL); este endpoint solo guarda la vinculación: no verifica el DNS ni emite certificados.

Requisitos previos:
- El CNAME ya debe existir en tu cuenta (añadido desde el panel). Si no: Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- Debe estar dentro del límite de CNAMEs de tu plan.

Parámetros:
- CNAME (obligatorio): el nombre de host completo, p. ej. docs.example.com
- IsCloudflare (opcional, por defecto 0).

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Añadir CNAME

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

CNAMEp. ej. docs.example.com
IsCloudflaretrue | falseOpcional. 0 (por defecto) o 1. Pon 1 si tu DNS está detrás del proxy de Cloudflare.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

POST/api/add-cname/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/add-cname/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CNAME=docs.example.com' \
  --data-urlencode 'IsCloudflare=0'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Listar CNAMEs

Todos los CNAMEs personalizados de quien hace la llamada. Cada elemento: { CNAME, Documents (recuento de flipbooks activos), FlipbookIDs ([...] con los IDs de los flipbooks activos vinculados a ese CNAME) }.

GEThttps://go.fliplink.me/api/list-cnames
Requisitos previosQuién soy(una API key válida)Listar CNAMEs

Sin parámetros.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-cnames
curl -X GET 'https://go.fliplink.me/api/list-cnames' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Eliminar CNAME

Quita la vinculación de un dominio personalizado (CNAME) de uno o de todos tus flipbooks. Dos modos:

  • Masivo (por defecto): pasa CNAME=<host> y deja FlipbookID en blanco; quita ese CNAME de todos los flipbooks que tengas.
  • Por flipbook: pasa FlipbookID=<id>; el CNAME se obtiene de ese flipbook. Úsalo para una acción «Quitar CNAME» fila a fila.

Respuesta (por flipbook): { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
Respuesta (masivo): { "Result": "OK", "Message": "CNAME removed successfully" }
Faltan ambos: { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

Nota: pasa el CNAME como parámetro de consulta (no como segmento de la URL) para evitar problemas con los puntos del nombre de host.

DELETEhttps://go.fliplink.me/api/delete-cname
Requisitos previosQuién soy(una API key válida)Listar CNAMEs(encuentra el CNAME / FlipbookID)Eliminar CNAME

Parámetros de consulta

CNAMEObligatorio en modo MASIVO (quita el CNAME de todos los flipbooks que tengas). Se ignora cuando FlipbookID > 0: en ese caso el CNAME se toma de ese flipbook.
FlipbookIDnumberOpcional. Pasa un ID de flipbook > 0 para quitar el CNAME SOLO de ese flipbook (modo por flipbook). Déjalo en blanco/omítelo/0 para el modo masivo (quitar de todos).

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

DELETE/api/delete-cname
curl -X DELETE 'https://go.fliplink.me/api/delete-cname?CNAME=docs.example.com&FlipbookID=%3CFlipbookID%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Carpetas

Listar carpetas

Lista tus carpetas, cada una como { Folder (name), URL (a folder GUID) }. Las carpetas se derivan de las asignaciones de flipbooks (creadas con assign-to-folder), así que una carpeta vacía no aparece en la lista. Los nombres de carpeta alimentan assign-to-folder (para colocar un flipbook) y set-team-member (para acotar el acceso de un miembro del equipo).

GEThttps://go.fliplink.me/api/list-folders
Requisitos previosQuién soy(una API key válida)Listar carpetas

Sin parámetros.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-folders
curl -X GET 'https://go.fliplink.me/api/list-folders' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Miembros del equipo

Listar miembros del equipo

Lista los miembros del equipo (usuarios del proveedor) de tu cuenta con sus datos de acceso, incluidas las carpetas a las que está asignado cada miembro. Las contraseñas nunca se devuelven. Filtra por IsActive.

GEThttps://go.fliplink.me/api/list-team-members
Requisitos previosQuién soy(una API key válida)Listar miembros del equipo

Parámetros de consulta

IsActivetrue | false1=activos (por defecto), 0=inactivos

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-team-members
curl -X GET 'https://go.fliplink.me/api/list-team-members?IsActive=1' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Obtener miembro del equipo

Devuelve un único miembro del equipo por su ID de miembro (el ID de list-team-members): nombre, correo, estado activo y las carpetas a las que está asignado. Un miembro del equipo está limitado a las carpetas definidas con set-team-member (el campo Folders), así que solo puede acceder a los flipbooks que estén dentro de esas carpetas. Las contraseñas nunca se devuelven. El memberId es el ID del miembro del equipo (de List Team Members), no un ID de flipbook; si pasas un ID de flipbook, obtienes "Team member not found". El miembro se devuelve envuelto en un objeto Item; Folders es una lista separada por comas de las carpetas a las que puede acceder (vacío = sin restricción de carpeta).

GEThttps://go.fliplink.me/api/get-team-member/{memberId}
Requisitos previosQuién soy(una API key válida)Definir miembro del equipo (crear o actualizar)(crea antes un miembro)Obtener miembro del equipo

Parámetros de ruta

memberIdnumberID del miembro del equipo (de list-team-members). NO es un ID de flipbook.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200No team member with that ID (e.g. you passed a flipbook ID){ "Result": "ERROR", "Message": "Team member not found" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/get-team-member/{memberId}
curl -X GET 'https://go.fliplink.me/api/get-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Definir miembro del equipo (crear o actualizar)

Crea un nuevo miembro del equipo (usuario del proveedor) o actualiza uno existente, controlando quién puede acceder a tu cuenta y, a través del campo Folders, a qué carpetas queda limitado (un miembro solo ve los flipbooks que estén dentro de sus carpetas asignadas). Si todo va bien, se escribe una entrada en el registro de auditoría.

Errores comunes: el nombre del miembro es un único campo Name; no hay FirstName/LastName. Folders es una lista separada por comas de nombres de carpeta de List Folders (p. ej. Marketing,Sales); déjalo vacío para no poner ninguna restricción de carpeta. Crear un miembro devuelve { Result:"OK", Message:"Team member created" } (la vía de actualización —cuando se indica ID— devuelve "Updated successfully"). El correo del miembro no puede pertenecer ya a un usuario de FlipLink, y los correos con alias + se rechazan.

POSThttps://go.fliplink.me/api/set-team-member
Requisitos previosQuién soy(una API key válida)Listar carpetas(nombres para el alcance de Folders)Definir miembro del equipo (crear o actualizar)

Parámetros del cuerpo

Namep. ej. Jane
Emailemailp. ej. jane@example.com
IDnumberOmítelo o pon -1 para crear. >0 para actualizar.
PasswordEn texto plano; se cifra en el servidor. Si lo dejas vacío al actualizar, se conserva el actual.
ProfileImageURL
FoldersLas carpetas a las que queda restringido este miembro: una lista delimitada de nombres de carpeta (de list-folders). El miembro solo puede acceder a los flipbooks que estén dentro de esas carpetas.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

POST/api/set-team-member
curl -X POST 'https://go.fliplink.me/api/set-team-member' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Jane' \
  --data-urlencode 'Email=jane@example.com' \
  --data-urlencode 'ID=-1' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'ProfileImage=<ProfileImage>' \
  --data-urlencode 'Folders=<Folders>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Team member created"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros del cuerpo

Activar miembro del equipo

Activa o desactiva a un miembro del equipo, controlando si puede iniciar sesión y acceder a la cuenta.

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}
Requisitos previosQuién soy(una API key válida)Definir miembro del equipo (crear o actualizar)(crea antes un miembro)Activar miembro del equipo

Parámetros de ruta

memberIdnumberID del miembro del equipo (de list-team-members). NO es un ID de flipbook.

Parámetros del cuerpo

IsActivetrue | falsep. ej. true

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-team-member-active/{memberId}
curl -X PUT 'https://go.fliplink.me/api/set-team-member-active/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsActive=true'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Eliminar miembro del equipo

Borrado lógico (desactivación). Los miembros del equipo nunca se borran de verdad: esto desactiva al miembro (un alias REST de set-team-member-active con IsActive=false). Su historial de pagos y sus referencias de auditoría se conservan, y se le puede reactivar más adelante con PUT /api/set-team-member-active (IsActive=true).

Respuesta: { "Result": "OK", "Message": "Team member deactivated" }.

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}
Requisitos previosQuién soy(una API key válida)Definir miembro del equipo (crear o actualizar)(crea antes un miembro)Eliminar miembro del equipo

Parámetros de ruta

memberIdnumberID del miembro del equipo (de list-team-members). NO es un ID de flipbook.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

DELETE/api/delete-team-member/{memberId}
curl -X DELETE 'https://go.fliplink.me/api/delete-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Team member deactivated"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Leads y ventas

Listar leads

Lista los datos de captación de leads recogidos por tus flipbooks. Devuelve Items[] más un esquema dinámico Columns[] (para renderizar una tabla) y TotalRecordCount. Admite paginación y exportación a CSV mediante IsDownload.

GEThttps://go.fliplink.me/api/list-leads
Requisitos previosQuién soy(una API key válida)Listar leads

Parámetros de consulta

ItemIDsIDs de flipbook separados por coma O por barra vertical (vacío = todos)
SearchText
PageNonumberp. ej. 1
Offsetnumberp. ej. 0
IsDownloadtrue | falsep. ej. true

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-leads
curl -X GET 'https://go.fliplink.me/api/list-leads?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Listar ventas

Lista los registros de venta/compra de tus flipbooks (correo del comprador, flipbook, importe, fecha) más las definiciones de columna de la tabla de ventas. Admite paginación y exportación a CSV mediante IsDownload.

GEThttps://go.fliplink.me/api/list-sales
Requisitos previosQuién soy(una API key válida)Listar ventas

Parámetros de consulta

ItemIDs
SearchText
PageNonumberp. ej. 1
Offsetnumberp. ej. 0
IsDownloadtrue | falsep. ej. true
IsAbandonedtrue | falsetrue → devuelve las ventas con carrito abandonado en lugar de las ventas completadas

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-sales
curl -X GET 'https://go.fliplink.me/api/list-sales?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true&IsAbandoned=false' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Eliminar lead

Elimina un único lead capturado por su ID. El segmento de la ruta es el leadId; pasa también el Email del lead y su FlipbookID como parámetros de consulta.

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}
Requisitos previosQuién soy(una API key válida)Listar leads(consigue un ID de lead)Eliminar lead

Parámetros de ruta

leadIdnumberEl ID del lead (el LeadID de list-leads).

Parámetros de consulta

Emailemailp. ej. foo@example.com
FlipbookIDnumberp. ej. {{flipbookId}}

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

DELETE/api/delete-lead/{leadId}
curl -X DELETE 'https://go.fliplink.me/api/delete-lead/{leadId}?Email=foo%40example.com&FlipbookID=%7B%7BflipbookId%7D%7D' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros de consulta

Eliminar leads (en bloque)

Elimina leads en bloque por filtro. Hace falta AL MENOS UNO de FlipbookID/Email/DateFrom/DateTo: una llamada sin filtro se rechaza (no existe una vía de «eliminar todo»). Siempre acotado al proveedor. Devuelve { Result, Deleted (recuento) }. También limpia las filas hijas (registro de vistas / clics en CTA / registro de exportación a hojas).

DELETEhttps://go.fliplink.me/api/delete-leads
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(acota por FlipbookID)Eliminar leads (en bloque)

Parámetros de consulta

FlipbookIDnumberOpcional. Elimina los leads solo de este flipbook.
EmailemailOpcional. Coincidencia EXACTA de correo.
DateFromOpcional. Elimina los leads capturados en esta fecha o después (coincide con Lead.CreatedOn). Cualquier fecha analizable, p. ej. 2026-01-01 o 2026-01-01T00:00:00Z.
DateToOpcional. Elimina los leads capturados en esta fecha o antes.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

DELETE/api/delete-leads
curl -X DELETE 'https://go.fliplink.me/api/delete-leads?FlipbookID=%7B%7BflipbookId%7D%7D&Email=%3CEmail%3E&DateFrom=%3CDateFrom%3E&DateTo=%3CDateTo%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Registrar compra de flipbook

Registra una venta (compra) completada de un flipbook: úsalo para anotar las compras hechas a través de tu propio flujo de pago, sin pasar por el checkout de Stripe de FlipLink.

Parámetro de ruta: {flipbookId}: el flipbook que se marca como comprado.

Cuerpo (urlencoded):
- Email: el correo del comprador (obligatorio)
- PaymentRef: la referencia de tu pasarela de pago, p. ej. un ID de PaymentIntent de Stripe (obligatorio)

Respuesta (éxito): { "Result": "OK", "Message": "Purchase recorded successfully" }
Respuesta (error): { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

Errores comunes: envía PaymentRef; NO envíes Amount/Currency: esos se derivan en el servidor a partir de tu referencia de pago.

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Registrar compra de flipbook

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

EmailemailDirección de correo del comprador (obligatoria).
PaymentRefReferencia del payment-intent de la pasarela (obligatoria). En Stripe es el ID del PaymentIntent (`pi_...`).

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

POST/api/set-flipbook-purchase/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Email=customer@example.com' \
  --data-urlencode 'PaymentRef=pi_3O1234567890abcdef'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Consultas

Listar plantillas

Lista las plantillas de flipbook reutilizables guardadas en tu cuenta. Filtra por DocType (0 = todas). Usa el ID de una plantilla en los flujos de save-as-template / create.

GEThttps://go.fliplink.me/api/list-templates
Requisitos previosQuién soy(una API key válida)Listar plantillas

Parámetros de consulta

DocTypenumber0 = Flipbook (por defecto), 1 = Document

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-templates
curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Listar skins

Lista los skins/temas disponibles del visor; cada fila lleva la URL del fondo incluido con el skin. Usa el nombre de un skin con set-skin.

GEThttps://go.fliplink.me/api/list-skins
Requisitos previosQuién soy(una API key válida)Listar skins

Parámetros de consulta

Typetrue | false0=skins de Flipbook, 1=skins de Document

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

RelacionadosDefinir skin
GET/api/list-skins
curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de consulta

Listar monedas

Lista las monedas disponibles a la hora de vender un flipbook (para los ajustes de venta/checkout).

GEThttps://go.fliplink.me/api/list-currencies
Requisitos previosQuién soy(una API key válida)Listar monedas

Sin parámetros.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-currencies
curl -X GET 'https://go.fliplink.me/api/list-currencies' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Listar música de fondo

Lista las pistas de música de fondo integradas que puedes asociar al visor de un flipbook.

GEThttps://go.fliplink.me/api/list-background-music
Requisitos previosQuién soy(una API key válida)Listar música de fondo

Sin parámetros.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

GET/api/list-background-music
curl -X GET 'https://go.fliplink.me/api/list-background-music' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Secciones — Marca y contenido

Definir metadatos

Define el título y los metadatos SEO del flipbook: Title, Description, TitleColor y el flag IsPublished.

Nota: esto sobrescribe Title/Description/TitleColor. Para cambiar solo el estado de publicación, usa set-published.

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir metadatos

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

Title
Description
TitleColor
IsPublishedtrue | falsep. ej. false

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-meta/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-meta/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=<Title>' \
  --data-urlencode 'Description=<Description>' \
  --data-urlencode 'TitleColor=<TitleColor>' \
  --data-urlencode 'IsPublished=false'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir publicación (publicar / despublicar)

Publica o despublica el flipbook: cambia SOLO el flag de publicación y deja Title/Description/TitleColor intactos (a diferencia de set-meta). Úsalo para (re)publicar un flipbook, por ejemplo uno que volvió sin publicar de create-by-file.

PUThttps://go.fliplink.me/api/set-published/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir publicación (publicar / despublicar)

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsPublishedtrue | falsetrue/1 = publicar, false/0 = despublicar (obligatorio).

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

RelacionadosDefinir metadatos
PUT/api/set-published/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-published/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir skin

Aplica un skin/tema del visor al flipbook; el servidor resuelve el nombre del skin a su ID.

Errores comunes: el campo es SkinName (la cadena de list-skins), no un ID numérico.

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Listar skins(elige un SkinName)Definir skin

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

SkinNameDe /api/list-skins → columna Name

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

RelacionadosListar skins
PUT/api/set-skin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-skin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName=<SkinName>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir imagen de fondo

Define la imagen de fondo del visor a partir de una URL que tú indiques (no hay una galería incorporada).

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir imagen de fondo

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

BackgroundIMGURLLa URL de una imagen O una URL de marcador de posición como https://plchldr.co/i/100x100?text=&bg=HEX

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-background-image/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-image/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundIMG=<BackgroundIMG>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir favicon

Define el favicon (el icono de la pestaña del navegador) que usa la página del visor alojado del flipbook.

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir favicon

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

FaviconIMGURL

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

RelacionadosDefinir logo
PUT/api/set-favicon/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-favicon/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG=<FaviconIMG>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir apariencia de la página

Configura la apariencia de las páginas del visor: el fondo, la sombra de la página, el espaciado y otras opciones de aspecto. Los valores se guardan tal cual; los elementos más antiguos pueden devolver otros valores (p. ej. regular, o el numérico 1) al leerse con Get one.

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir apariencia de la página

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

PageDepthenumflat | thin | thickUno de: flat, thin, thick
CoverTypeenumsoft | hardUno de: soft, hard

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-page-appearance/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir texto de carga

Define el texto personalizado que se muestra en la pantalla de carga del visor.

Errores comunes: el campo es CustomLoadingText, no LoadingText.

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir texto de carga

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

CustomLoadingText

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-loading-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-loading-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText=<CustomLoadingText>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir URL personalizada

Define el slug personalizado (vanity) de la URL de compartir del flipbook. Debe ser único; un slug ya en uso devuelve Result:ERROR.

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir URL personalizada

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

CustomURL

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Custom URL already taken{ "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-custom-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-custom-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=<CustomURL>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir PDF de vista previa

Define el PDF de vista previa que se muestra a los lectores antes de la captación de leads / el pago. Se borra automáticamente si tanto la captación de leads como el modo de venta están desactivados.

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir PDF de vista previa

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

PreviewPDFURL

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-preview-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=<PreviewPDF>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir PDF de imagen

Define el PDF solo de imagen/vista previa que se usa para las miniaturas y las vistas previas. Envíalo vacío para conservar el PDF de imagen actual.

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir PDF de imagen

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IMGPdfURL

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-image-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=<IMGPdf>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — Visor y lectura

Definir controles del visor

Muestra u oculta cada botón de la barra de herramientas del visor (descargar, imprimir, compartir, pantalla completa, zoom, miniaturas, etc.).

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir controles del visor

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsShowControlstrue | falsep. ej. true
IsPrinttrue | falsep. ej. false
IsDownloadtrue | falsep. ej. false
IsThumbnailstrue | falsep. ej. true
IsSearchtrue | falsep. ej. true
IsSoundtrue | falsep. ej. true
IsFullscreentrue | falsep. ej. true
IsZoomtrue | falsep. ej. true
IsNotestrue | falsep. ej. false

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-viewer-controls/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir navegación de lectura

Configura la navegación de lectura en el visor: las miniaturas de página, el índice de contenidos y cómo se mueven los lectores entre páginas.

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir navegación de lectura

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsNavFirstLasttrue | falsep. ej. true
BookLayoutenum1=una página, 2=doble páginaUno de: 1, 2
IsRightToLefttrue | falsep. ej. false
ScrollBehaviournumberModo de desplazamiento numérico

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-reader-navigation/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir cambio de página automático

Activa o desactiva el cambio de página automático en el visor y su intervalo.

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir cambio de página automático

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

AutoFlipInSecsnumberEn MILISEGUNDOS, a pesar del nombre. 0 = desactivado, 3000 = 3 s, 5000 = 5 s, etc.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-auto-flip/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir música de fondo

Define o quita la pista de música de fondo que suena en el visor. Consulta las pistas disponibles en list-background-music.

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Listar música de fondo(elige una pista)Definir música de fondo

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

BackgroundMusicNombre de archivo de una pista predefinida (de /api/list-background-music)
BackgroundMusicCustomURLURL de música subida personalizada
IsBackgroundMusicLooptrue | falsep. ej. false

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-background-music/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-music/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=<BackgroundMusic>' \
  --data-urlencode 'BackgroundMusicCustom=<BackgroundMusicCustom>' \
  --data-urlencode 'IsBackgroundMusicLoop=false'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — CTAs

Definir CTA principal

Configura el botón de llamada a la acción principal del visor (texto, URL, posición, color).

Errores comunes: los campos son IsCTAButton, CTAButtonText, CTAButtonURL (más la posición/color), no Text/URL/Position.

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir CTA principal

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsCTAButtontrue | falsep. ej. false
CTAButtonText
CTAButtonColor
CTAButtonURLURLLos prefijos mailto: / tel: se normalizan automáticamente en el servidor
CTAButtonTextColor

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-cta-primary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=<CTAButtonText>' \
  --data-urlencode 'CTAButtonColor=<CTAButtonColor>' \
  --data-urlencode 'CTAButtonURL=<CTAButtonURL>' \
  --data-urlencode 'CTAButtonTextColor=<CTAButtonTextColor>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir CTA secundaria

Configura el botón de llamada a la acción secundario del visor.

Errores comunes: el botón secundario usa los campos con el sufijo 2: IsCTAButton2, CTAButtonText2, CTAButtonURL2.

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir CTA secundaria

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsCTAButton2true | falsep. ej. false
CTAButtonText2
CTAButtonColor2
CTAButtonTextColor2
CTAButtonURL2URL

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-cta-secondary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=<CTAButtonText2>' \
  --data-urlencode 'CTAButtonColor2=<CTAButtonColor2>' \
  --data-urlencode 'CTAButtonTextColor2=<CTAButtonTextColor2>' \
  --data-urlencode 'CTAButtonURL2=<CTAButtonURL2>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir reglas de vista previa de la CTA

Configura cuándo se muestra la llamada a la acción a los lectores, p. ej. tras N páginas o N segundos (las reglas de la barrera de vista previa).

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir reglas de vista previa de la CTA

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsCTAHiddenInPreviewtrue | falsep. ej. false

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-cta-preview-rules/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — Control de acceso

Definir acceso con contraseña

Activa o desactiva la protección con contraseña del flipbook y define la contraseña de acceso.

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir acceso con contraseña

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsPasswordProtectedtrue | falsep. ej. false
Password
PwdTitle
PwdPlaceholder
PwdButton

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-password-access/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-password-access/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'PwdTitle=<PwdTitle>' \
  --data-urlencode 'PwdPlaceholder=<PwdPlaceholder>' \
  --data-urlencode 'PwdButton=<PwdButton>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir indexación

Controla la indexación del flipbook alojado por parte de los motores de búsqueda. IsNoIndex=true añade un noindex de robots para que la página no se indexe.

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir indexación

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsNoIndextrue | falsep. ej. false

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-indexing/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-indexing/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNoIndex=false'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir lista de correos permitidos

Restringe el acceso al visor a una lista de direcciones de correo permitidas (visualización con control de acceso).

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir lista de correos permitidos

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

EmailsAllowedLista delimitada de correos permitidos

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-email-allow-list/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=<EmailsAllowed>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — Captación de leads

Definir captación de leads (base)

Activa y configura el formulario base de captación de leads (la barrera que recoge los datos del visitante antes de que lea).

Errores comunes: el flag para activarlo es IsLeadCapture, no IsEnabled.

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir captación de leads (base)

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsLeadCapturetrue | falsep. ej. false
LeadCaptureTitle
IsLeadAllowSkiptrue | falsep. ej. false
LeadSkipText
LeadFormAfterPagesnumberp. ej. 0
LeadAfterPagesnumberp. ej. 0

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-lead-capture/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=false' \
  --data-urlencode 'LeadCaptureTitle=<LeadCaptureTitle>' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=<LeadSkipText>' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir campos de lead

Activa o desactiva cada campo estándar de captación de leads (nombre, correo, teléfono, empresa, etc.) y si es obligatorio.

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir captación de leads (base)(activa la captación de leads)Definir campos de lead

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsLeadEmailtrue | falsep. ej. true
IsLeadEmailMandatorytrue | falsep. ej. true
IsLeadNametrue | falsep. ej. true
IsLeadNameMandatorytrue | falsep. ej. false
IsLeadPhonetrue | falsep. ej. false
IsLeadPhoneMandatorytrue | falsep. ej. false
IsLeadCompanytrue | falsep. ej. false
IsLeadCompanyMandatorytrue | falsep. ej. false
IsLeadDatetrue | falsep. ej. false
IsLeadDateMandatorytrue | falsep. ej. false
LeadPhoneCountry

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-lead-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadEmail=true' \
  --data-urlencode 'IsLeadEmailMandatory=true' \
  --data-urlencode 'IsLeadName=true' \
  --data-urlencode 'IsLeadNameMandatory=false' \
  --data-urlencode 'IsLeadPhone=false' \
  --data-urlencode 'IsLeadPhoneMandatory=false' \
  --data-urlencode 'IsLeadCompany=false' \
  --data-urlencode 'IsLeadCompanyMandatory=false' \
  --data-urlencode 'IsLeadDate=false' \
  --data-urlencode 'IsLeadDateMandatory=false' \
  --data-urlencode 'LeadPhoneCountry=<LeadPhoneCountry>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir campos personalizados de lead

Define campos personalizados extra en el formulario de captación de leads, más allá de los estándar de nombre/correo/teléfono.

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir captación de leads (base)(activa la captación de leads)Definir campos personalizados de lead

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsLeadCustom1true | falsep. ej. false
IsLeadCustom1Mandatorytrue | falsep. ej. false
Custom1Label
IsLeadCustom2true | falsep. ej. false
IsLeadCustom2Mandatorytrue | falsep. ej. false
Custom2Label

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-lead-custom-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=<Custom1Label>' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label=<Custom2Label>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir etiquetas de lead

Define las etiquetas visibles y el texto de marcador de posición de los campos del formulario de captación de leads.

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir captación de leads (base)(activa la captación de leads)Definir etiquetas de lead

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

LeadEmailemail
LeadName
LeadPhonephone
LeadCompany
LeadDate
LeadButton

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-lead-labels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=<LeadEmail>' \
  --data-urlencode 'LeadName=<LeadName>' \
  --data-urlencode 'LeadPhone=<LeadPhone>' \
  --data-urlencode 'LeadCompany=<LeadCompany>' \
  --data-urlencode 'LeadDate=<LeadDate>' \
  --data-urlencode 'LeadButton=<LeadButton>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir privacidad de leads

Configura el texto y las opciones de privacidad/consentimiento de la captación de leads (p. ej. la casilla de consentimiento del RGPD).

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir captación de leads (base)(activa la captación de leads)Definir privacidad de leads

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsLeadPrivacyPolicytrue | falsep. ej. false
PrivacyPolicyURLURL
PrivacyPolicyText

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-lead-privacy/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-privacy/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadPrivacyPolicy=false' \
  --data-urlencode 'PrivacyPolicyURL=<PrivacyPolicyURL>' \
  --data-urlencode 'PrivacyPolicyText=<PrivacyPolicyText>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir verificación de leads

Activa o desactiva la verificación de correo de los leads, obligando a los visitantes a confirmar su correo antes de acceder.

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir captación de leads (base)(activa la captación de leads)Definir verificación de leads

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsVerifyEmailtrue | falsep. ej. false
IsVerifyMobiletrue | falsep. ej. false
TwillioAPIKeyTu API key de Twilio (el nombre del campo mantiene la grafía original «Twillio»).
EmailVerifyTitleText
EmailVerifyButtonText

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-lead-verification/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-verification/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVerifyEmail=false' \
  --data-urlencode 'IsVerifyMobile=false' \
  --data-urlencode 'TwillioAPIKey=<TwillioAPIKey>' \
  --data-urlencode 'EmailVerifyTitleText=<EmailVerifyTitleText>' \
  --data-urlencode 'EmailVerifyButtonText=<EmailVerifyButtonText>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir webhook de leads

Define una URL de webhook que recibe cada nuevo lead (guardada como el webhook de nuevo lead). Usa test-webhook para comprobar que se dispara.

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir captación de leads (base)(activa la captación de leads)Definir webhook de leads

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

WebhookURL_NewLeadURLLa URL de tu endpoint: recibe una carga útil JSON por cada nuevo lead.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-lead-webhook/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=<WebhookURL_NewLead>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Probar webhook

Dispara una carga útil de PRUEBA al webhook de leads configurado del flipbook para que verifiques el formato de entrega sin un lead real. Devuelve ERROR 'No lead webhook is configured for this flipbook.' si no hay ninguno configurado. La forma de la carga útil coincide con la de un lead real (claves: pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2) pero lleva valores ficticios (pdf_id:"-1", pdf_name:"Test PDF", ...). No se guarda ningún lead real ni se envía ningún correo de notificación.

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir webhook de leads(antes hay que configurar un webhook)Probar webhook

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

POST/api/test-webhook/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Definir Google Sheets de leads

Conecta la captación de leads a una hoja de Google: los nuevos leads se añaden a la hoja que indiques (sheet ID + nombre).

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir captación de leads (base)(activa la captación de leads)Definir Google Sheets de leads

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

GoogleSheetURLURL
GoogleSheetIDKey
GoogleSheetName

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-lead-google-sheets/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'GoogleSheetURL=<GoogleSheetURL>' \
  --data-urlencode 'GoogleSheetIDKey=<GoogleSheetIDKey>' \
  --data-urlencode 'GoogleSheetName=<GoogleSheetName>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — Notificaciones y plantillas de correo

Definir notificaciones

Configura qué notificaciones por correo recibes para este flipbook (nuevo lead, nueva vista, nueva venta).

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir notificaciones

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

NotificationsEmailemail
IsSendEmailOnViewtrue | falsep. ej. false

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-notifications/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-notifications/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=<NotificationsEmail>' \
  --data-urlencode 'IsSendEmailOnView=false'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir plantilla de correo — Nuevo lead

Define el correo que se envía cuando ocurre un nuevo lead. Envía valores vacíos para restaurar la plantilla NEW_LEAD por defecto.

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir plantilla de correo — Nuevo lead

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

EmailLeadSubject
EmailLeadBody

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-email-template-lead/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=<EmailLeadSubject>' \
  --data-urlencode 'EmailLeadBody=<EmailLeadBody>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir plantilla de correo — Nueva vista

Define la plantilla de correo que se envía en una notificación de nueva vista. Envíala vacía para restaurar la plantilla NEW_VIEW por defecto.

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir plantilla de correo — Nueva vista

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

EmailViewSubject
EmailViewBody

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-email-template-view/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=<EmailViewSubject>' \
  --data-urlencode 'EmailViewBody=<EmailViewBody>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir plantilla de correo — Nueva venta

Define la plantilla de correo que se envía en una notificación de nueva venta. Envíala vacía para restaurar la plantilla NEW_SALE por defecto.

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir plantilla de correo — Nueva venta

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

EmailSaleSubject
EmailSaleBody

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-email-template-sale/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=<EmailSaleSubject>' \
  --data-urlencode 'EmailSaleBody=<EmailSaleBody>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — Ventas

Definir ajustes de venta

Configura la venta del flipbook (precio, moneda, opciones). Activar el modo de venta activa automáticamente la verificación de correo y hace obligatorio el correo del lead.

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Listar monedas(elige SaleCurr)Definir ajustes de venta

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsForSaletrue | falsep. ej. false
SaleCurrDe /api/list-currencies
SaleAmountnumberp. ej. 0

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-sale-settings/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-settings/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsForSale=false' \
  --data-urlencode 'SaleCurr=USD' \
  --data-urlencode 'SaleAmount=0'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir texto de la página de venta

Define el texto de marketing que se muestra en la página de venta / checkout del flipbook.

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir ajustes de venta(activa la venta)Definir texto de la página de venta

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

SalePageTitle
SaleAccessPageTitle
SalePurchaseButtonText
SaleButtonText
SaleAccessButtonText
SaleButtonColor

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-sale-page-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-page-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SalePageTitle=<SalePageTitle>' \
  --data-urlencode 'SaleAccessPageTitle=<SaleAccessPageTitle>' \
  --data-urlencode 'SalePurchaseButtonText=<SalePurchaseButtonText>' \
  --data-urlencode 'SaleButtonText=<SaleButtonText>' \
  --data-urlencode 'SaleAccessButtonText=<SaleAccessButtonText>' \
  --data-urlencode 'SaleButtonColor=<SaleButtonColor>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir pasarela de venta

Selecciona y configura la pasarela de pago que se usa al vender este flipbook.

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir ajustes de venta(activa la venta)Definir pasarela de venta

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

SaleGatewayName
SaleGatewayKey
SaleGatewaySecret

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-sale-gateway/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-gateway/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SaleGatewayName=<SaleGatewayName>' \
  --data-urlencode 'SaleGatewayKey=<SaleGatewayKey>' \
  --data-urlencode 'SaleGatewaySecret=<SaleGatewaySecret>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — Aprobación

Definir botón de aprobación

Añade al visor un botón para solicitar aprobación. Activarlo dispara el flujo de solicitud de aprobación.

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(DocType=document — solo elementos Document)Definir botón de aprobación

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsApprovalButtontrue | falsep. ej. false
ApprovalButtonText
ApprovalButtonColor
ApprovalButtonTextColor

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-approval-button/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-button/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=false' \
  --data-urlencode 'ApprovalButtonText=<ApprovalButtonText>' \
  --data-urlencode 'ApprovalButtonColor=<ApprovalButtonColor>' \
  --data-urlencode 'ApprovalButtonTextColor=<ApprovalButtonTextColor>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir plantillas de correo de aprobación

Define las plantillas de correo que usa el flujo de aprobación. Los valores vacíos toman los valores por defecto.

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(DocType=document — solo elementos Document)Definir plantillas de correo de aprobación

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

EmailApproveRequestSubject
EmailApproveRequestBody
EmailApproveRemindSubject
EmailApproveRemindBody
EmailApproveSubmitSubject
EmailApproveSubmitBody

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-approval-email-templates/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=<EmailApproveRequestSubject>' \
  --data-urlencode 'EmailApproveRequestBody=<EmailApproveRequestBody>' \
  --data-urlencode 'EmailApproveRemindSubject=<EmailApproveRemindSubject>' \
  --data-urlencode 'EmailApproveRemindBody=<EmailApproveRemindBody>' \
  --data-urlencode 'EmailApproveSubmitSubject=<EmailApproveSubmitSubject>' \
  --data-urlencode 'EmailApproveSubmitBody=<EmailApproveSubmitBody>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — Compartir

Definir interruptor maestro de compartir

Interruptor maestro de encendido/apagado para los botones de compartir del visor.

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir interruptor maestro de compartir

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsShareButtonstrue | falsep. ej. false

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-share-master/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-master/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareButtons=false'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir canales para compartir

Activa o desactiva cada canal social para compartir (Facebook, X, LinkedIn, WhatsApp, correo, etc.) de forma individual en el menú de compartir del visor.

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir canales para compartir

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsShareFacebooktrue | falsep. ej. true
IsShareTwittertrue | falsep. ej. true
IsShareWhatsApptrue | falsep. ej. true
IsShareTelegramtrue | falsep. ej. false
IsShareLinkedIntrue | falsep. ej. true
IsSharePinteresttrue | falsep. ej. false
IsShareReddittrue | falsep. ej. false
IsShareTumblrtrue | falsep. ej. false
IsShareMessengertrue | falsep. ej. false
IsShareEmailtrue | falsep. ej. true
IsShareLinetrue | falsep. ej. false
IsShareWeChattrue | falsep. ej. false
IsShareInstagramtrue | falsep. ej. false
IsShareFlipboardtrue | falsep. ej. false
IsShareGeneraltrue | falsep. ej. true

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-share-channels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-channels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareFacebook=true' \
  --data-urlencode 'IsShareTwitter=true' \
  --data-urlencode 'IsShareWhatsApp=true' \
  --data-urlencode 'IsShareTelegram=false' \
  --data-urlencode 'IsShareLinkedIn=true' \
  --data-urlencode 'IsSharePinterest=false' \
  --data-urlencode 'IsShareReddit=false' \
  --data-urlencode 'IsShareTumblr=false' \
  --data-urlencode 'IsShareMessenger=false' \
  --data-urlencode 'IsShareEmail=true' \
  --data-urlencode 'IsShareLine=false' \
  --data-urlencode 'IsShareWeChat=false' \
  --data-urlencode 'IsShareInstagram=false' \
  --data-urlencode 'IsShareFlipboard=false' \
  --data-urlencode 'IsShareGeneral=true'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Secciones — Seguimiento e IA

Definir seguimiento de analítica

Añade tus propios IDs de seguimiento de analítica (p. ej. Google Analytics, GTM, Facebook Pixel) al flipbook alojado.

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir seguimiento de analítica

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

FacebookAnalyticsCode
GoogleAnalyticsCode
GoogleTagManager

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-analytics-tracking/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=<FacebookAnalyticsCode>' \
  --data-urlencode 'GoogleAnalyticsCode=<GoogleAnalyticsCode>' \
  --data-urlencode 'GoogleTagManager=<GoogleTagManager>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir proveedor de IA

Configura el proveedor de IA que se usa para las funciones de IA: el nombre del proveedor y su API key.

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir proveedor de IA

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

AIProvider
AIKey

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-ai-provider/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=<AIProvider>' \
  --data-urlencode 'AIKey=<AIKey>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir asistente virtual

Configura los ajustes base del asistente virtual del visor (chat/ayuda).

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir asistente virtual

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

IsVAtrue | falsep. ej. false
VAButtonText
VAButtonColor
VAButtonTextColor
VATextPrompt / instrucciones del asistente
VAEmbeddingsBlob de embeddings (cadena)

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-virtual-assistant/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=<VAButtonText>' \
  --data-urlencode 'VAButtonColor=<VAButtonColor>' \
  --data-urlencode 'VAButtonTextColor=<VAButtonTextColor>' \
  --data-urlencode 'VAText=<VAText>' \
  --data-urlencode 'VAEmbeddings=<VAEmbeddings>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo

Definir texto de estado del asistente virtual

Define el texto de estado/saludo que muestra el asistente virtual del visor.

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}
Requisitos previosQuién soy(una API key válida)Crear desde un archivo(consigue un flipbookId)Definir texto de estado del asistente virtual

Parámetros de ruta

flipbookIdnumberID numérico del flipbook/documento, devuelto por create-by-file / create-by-url (como ID) o por list.

Parámetros del cuerpo

VAButtonStatus1Etiqueta del estado «escuchando»
VAButtonStatus2Etiqueta del estado «grabando»
VAButtonStatus3Etiqueta del estado «procesando»
VAButtonStatus4Etiqueta del estado «hablando»

Respuestas de error

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Una clave ausente o no válida se rechaza con HTTP 401 (una página HTML, sin JSON). Cualquier otro error devuelve HTTP 200 con { "Result": "ERROR", "Message": … }, así que actúa siempre según Result, no solo según el código de estado HTTP.

PUT/api/set-virtual-assistant-status-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=<VAButtonStatus1>' \
  --data-urlencode 'VAButtonStatus2=<VAButtonStatus2>' \
  --data-urlencode 'VAButtonStatus3=<VAButtonStatus3>' \
  --data-urlencode 'VAButtonStatus4=<VAButtonStatus4>'
Respuesta de ejemplo200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Pega tu API key en “Tu API key” arriba; luego rellena los campos de abajo y envía.

Parámetros de ruta: necesarios para identificar el elemento

Parámetros del cuerpo