Buscar flipbooks e seus detalhes

Flipbooks

Leia seus flipbooks pela API — busque um único registro por ID, encontre um pela URL pública, percorra toda a sua biblioteca em páginas e obtenha os links do PDF e do visualizador.

APIs usadas nesta discussão

Algo impreciso ou desatualizado neste guia?

O que você pode fazer

Estes cinco endpoints somente leitura cobrem todas as formas de ler um flipbook de volta do FlipLink — quer você tenha o ID numérico dele, só a URL pública ou nada além da vontade de percorrer tudo o que é seu:

Get one — o registro completo de um flipbook pelo seu flipbookId.
Find by URL — encontre um flipbook pela sua URL pública/de compartilhamento.
List — liste seus flipbooks/documentos em páginas.
Get the PDF URL — o link público do S3 para o PDF principal de um item.
Get the share link — a URL pública do visualizador de um item.

Antes de começar

Uma chave de API — enviada em toda requisição como cabeçalho X-Api-Key ou Authorization: Bearer YOUR_API_KEY.
Todas as requisições vão para a URL base https://go.fliplink.me.
Três destes endpoints recebem um parâmetro de caminho {flipbookId} — o ID numérico do flipbook/documento, retornado por create-by-file / create-by-url (como ID) ou por List. Os outros dois (Find by URL, List) recebem parâmetros de query string.
Todos os cinco são requisições GET e não enviam corpo.

Get one — um flipbook

GET /api/get/{flipbookId} retorna o registro completo de um único flipbook/documento por ID — cada coluna armazenada: título, URLs, contagens de visualizações/leads/vendas, pasta e flags de status. O registro completo é retornado envolvido em um objeto Item com cerca de 190 colunas; o exemplo abaixo é um subconjunto abreviado e representativo.

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

Resposta:

{
  "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"
  }
}

Find by URL — encontre um flipbook pela URL

GET /api/find-by-url encontra um flipbook pela sua URL pública/de compartilhamento e retorna o registro completo (mesmo formato do Get one). Passe a URL completa do visualizador, uma URL de CNAME ou apenas o slug simples de CustomURL no parâmetro de query URL — o servidor toma o último segmento do caminho como o slug.

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

Resposta (abreviada — o registro completo tem cerca de 190 colunas):

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

List — liste seus flipbooks

GET /api/list lista seus flipbooks/documentos em páginas (PageNo/PageSize). Cada item inclui IDs, título, URLs, contagens de visualizações/leads/vendas, pasta e flags de status. Você também pode filtrar com Folder e SearchText, paginar com PageNo, PageSize e Offset, e ordenar com SortBy e SortOrder.

SortBy aceita um de Name, DocType, CreatedOn, NoOfViews, NoOfLeads (vazio = ordenação padrão; valores desconhecidos voltam ao padrão). SortOrder é ASC ou DESC — ignorado se SortBy estiver vazio, e valores desconhecidos voltam silenciosamente ao padrão.

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

Resposta:

{
  "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
}

Get PDF URL — obtenha a URL do PDF de um flipbook

GET /api/get-pdf/{flipbookId} retorna a URL pública do S3 do PDF principal do item (versão mesclada se houver envoltório de frente/verso).

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

Resposta:

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

GET /api/get-share-link/{flipbookId} retorna a URL pública do visualizador do flipbook (o prefixo de domínio personalizado/host mais o slug de compartilhamento do flipbook).

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

Resposta:

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

Erros possíveis

Chave de API ausente ou inválida → HTTP 401. Isso retorna uma página HTML de Unauthorized simples — não há corpo JSON. Confira se o cabeçalho X-Api-Key (ou Authorization: Bearer) está presente e correto. Isso vale para todos os cinco endpoints.
flipbookId desconhecido (ou que não pertence à sua chave) → HTTP 200, mensagem Item not found. Isso vale para Get one, Get PDF URL e Get Share Link.

Notas

Get one e Find by URL retornam o mesmo formato de registro completo envolvido em um objeto Item.
List envolve os resultados em um array Items e inclui campos de paginação (TotalRecordCount, TotalItems, UserItems, PageSize, Capped).
Get PDF URL e Get Share Link retornam cada um apenas um campo URL ao lado de Result.

Discussões relacionadas

Páginas de capa, expiração do link e fixação Criar um flipbook (a partir de um PDF ou de uma URL)Excluir um flipbook Organizar flipbooks com pastas e modelos Substituir o PDF de um flipbook e duplicá-lo

Buscar flipbooks e seus detalhes

APIs usadas nesta discussão

O que você pode fazer

Antes de começar

Get one — um flipbook

Find by URL — encontre um flipbook pela URL

List — liste seus flipbooks

Get PDF URL — obtenha a URL do PDF de um flipbook

Get share link — obtenha o link de compartilhamento de um flipbook

Erros possíveis

Notas

Discussões relacionadas