FlipLink

フリップブックとその詳細を取得する

フリップブック

フリップブックをAPIで取得します。IDで単一のレコードを取得し、公開URLから検索し、ライブラリ全体をページ送りし、PDFとビューアーのリンクを取得できます。

このディスカッションで使うAPI

このガイドに誤りや古い情報がありますか？

できること

これら5つの読み取り専用エンドポイントは、FlipLinkからフリップブックを読み出したいあらゆる場面をカバーします。数値IDを持っている場合、公開URLしか分からない場合、あるいは所有するすべてをページ送りしたいだけの場合でも対応できます。

  • flipbookIdで1つのフリップブックの完全なレコードを取得する（Get one）。
  • URLで検索する — 公開／共有URLからフリップブックを検索する（Find by URL）。
  • フリップブック／ドキュメントをページ送りで一覧表示する（List）。
  • PDF URLを取得する — アイテムのメインPDFへの公開S3リンク。
  • 共有リンクを取得する — アイテムの公開ビューアーURL。

始める前に

  • APIキー — すべてのリクエストでX-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
  • すべてのリクエストの送信先はベースURL https://go.fliplink.meです。
  • これらのうち3つのエンドポイントは{flipbookId} パスパラメーター（create-by-file／create-by-urlが返す（IDとして）、または一覧が返すフリップブック／ドキュメントの数値ID）を取ります。残りの2つ（Find by URL、List）は代わりにクエリ文字列パラメーターを取ります。
  • 5つはいずれもGETリクエストで、リクエストボディは送りません。

1つのフリップブックを取得する

GET /api/get/{flipbookId}は、IDで1つのフリップブック／ドキュメントの完全なレコード（タイトル、URL、閲覧／リード／販売の件数、フォルダ、ステータスフラグなど、保存されたすべての列）を返します。完全なレコードは、約190列を持つ**Itemオブジェクトにラップされて**返されます。以下の例は、代表的なフィールドを抜粋したものです。

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

レスポンス:

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

URLでフリップブックを検索する

GET /api/find-by-urlは、公開／共有URLでフリップブックを検索し、その完全なレコード（Get oneと同じ形）を返します。完全なビューアーURL、CNAMEのURL、または裸のCustomURLスラッグをURLクエリパラメーターに渡してください。サーバーは最後のパスセグメントをスラッグとして扱います。

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'

レスポンス（抜粋 — 完全なレコードは約190列あります）:

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

フリップブックを一覧表示する

GET /api/listは、フリップブック／ドキュメントをページ送り（PageNo/PageSize）で一覧表示します。各アイテムには、ID、タイトル、URL、閲覧／リード／販売の件数、フォルダ、ステータスフラグが含まれます。FolderとSearchTextで絞り込み、PageNo、PageSize、Offsetでページ送りし、SortByとSortOrderで並べ替えることもできます。

SortByはName、DocType、CreatedOn、NoOfViews、NoOfLeadsのいずれかを受け付けます（空 = デフォルトの並び順、不明な値はデフォルトにフォールバック）。SortOrderはASCまたはDESCです。SortByが空の場合は無視され、不明な値は静かにデフォルトにフォールバックします。

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'

レスポンス:

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

フリップブックのPDF URLを取得する

GET /api/get-pdf/{flipbookId}は、アイテムのメインPDF（表紙・裏表紙でラップされている場合はマージ版）の公開S3 URLを返します。

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

レスポンス:

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

フリップブックの共有リンクを取得する

GET /api/get-share-link/{flipbookId}は、フリップブックの公開ビューアーURL（そのカスタムドメイン／ホストのプレフィックスと、フリップブックの共有スラッグ）を返します。

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

レスポンス:

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

起こりうるエラー

  • APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。X-Api-Key（またはAuthorization: Bearer）ヘッダーが存在し、正しいことを確認してください。これは5つのエンドポイントすべてに当てはまります。
  • 不明なflipbookId（またはキーが所有していないもの） → HTTP 200、メッセージはItem not found。これはGet one、Get PDF URL、Get Share Linkに当てはまります。

メモ

  • Get oneとFind by URLは、どちらもItemオブジェクトにラップされた同じ完全なレコードの形を返します。
  • Listは結果をItems配列にラップし、ページ送りのフィールド（TotalRecordCount、TotalItems、UserItems、PageSize、Capped）を含みます。
  • Get PDF URLとGet Share Linkは、それぞれResultとともに1つのURLフィールドだけを返します。

関連ディスカッション

カバーページ、リンクの有効期限、ピン留めフリップブックを作成する（PDFまたはURLから）フリップブックを削除するフォルダとテンプレートでフリップブックを整理するフリップブックのPDFを差し替える・複製する