جلب الكتيّبات وتفاصيلها

ما الذي يمكنك فعله

تغطّي نقاط النهاية الخمس هذه للقراءة فقط كل طريقة قد تحتاجها لاسترجاع كتيّب من FlipLink — سواء كان لديك مُعرّفه الرقمي، أو رابطه العام فقط، أو لا شيء سوى الرغبة في تصفّح كل ما تملكه:

• اجلب واحدًا — السجلّ الكامل لكتيّب واحد عبر flipbookId الخاص به.
• ابحث بالرابط — استعرض كتيّبًا انطلاقًا من رابطه العام / رابط المشاركة.
• اسرد كتيّباتك/مستنداتك على صفحات.
• احصل على رابط الـ PDF — رابط S3 العام لملف PDF الرئيسي للعنصر.
• احصل على رابط المشاركة — رابط العارض العام للعنصر.

قبل أن تبدأ

• مفتاح API — يُرسَل مع كل طلب إمّا في ترويسة X-Api-Key أو ضمن Authorization: Bearer YOUR_API_KEY.
• تذهب جميع الطلبات إلى الرابط الأساسي https://go.fliplink.me.
• تأخذ ثلاث من نقاط النهاية هذه معطى مسار {flipbookId} — المُعرّف الرقمي للكتيّب/المستند، الذي يُعيده create-by-file / create-by-url (بوصفه ID) أو تُعيده List. أما النقطتان الأخريان (البحث بالرابط، والسرد) فتأخذان معطيات سلسلة استعلام بدلًا من ذلك.
• النقاط الخمس جميعها طلبات GET ولا ترسل أي جسم طلب.

اجلب كتيّبًا واحدًا

يُعيد GET /api/get/{flipbookId} السجلّ الكامل لكتيّب/مستند مفرد عبر الـ ID — كل عمود مُخزَّن: العنوان، والروابط، وعدادات العرض/العملاء المحتملين/المبيعات، والمجلّد، ورايات الحالة. يُعاد السجلّ الكامل مُغلَّفًا داخل كائن Item يضمّ نحو 190 عمودًا؛ والمثال أدناه مجموعة فرعية مختصرة وتمثيلية.

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

ابحث عن كتيّب بالرابط

يستعرض GET /api/find-by-url كتيّبًا عبر رابطه العام / رابط المشاركة ويُعيد سجلّه الكامل (بالبنية نفسها كما في جلب واحد). مرّر رابط العارض الكامل، أو رابط CNAME، أو مجرّد لاحقة 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). يتضمّن كل عنصر المُعرّفات، والعنوان، والروابط، وعدادات العرض/العملاء المحتملين/المبيعات، والمجلّد، ورايات الحالة. كما يمكنك التصفية عبر 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 الكتيّب

يُعيد GET /api/get-pdf/{flipbookId} رابط S3 العام لملف PDF الرئيسي للعنصر (النسخة المدمجة إن كان مغلَّفًا بغلاف أمامي/خلفي).

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} رابط العارض العام للكتيّب (بادئة نطاقه المخصّص/مضيفه مضافًا إليها لاحقة مشاركة الكتيّب).

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. تُعيد هذه الحالة صفحة HTML عادية لعدم التصريح — دون أي جسم JSON. تحقّق من وجود ترويسة X-Api-Key (أو Authorization: Bearer) وصحّتها. وينطبق ذلك على نقاط النهاية الخمس جميعها.
• flipbookId مجهول (أو غير مملوك لمفتاحك) ← HTTP 200، والرسالة Item not found. وينطبق ذلك على جلب واحد، وجلب رابط الـ PDF، وجلب رابط المشاركة.

ملاحظات

• يُعيد كلٌّ من جلب واحد والبحث بالرابط بنية السجلّ الكامل نفسها مُغلَّفةً داخل كائن Item.
• يُغلِّف السرد نتائجه داخل مصفوفة Items ويتضمّن حقول التصفّح (TotalRecordCount وTotalItems وUserItems وPageSize وCapped).
• يُعيد كلٌّ من جلب رابط الـ PDF وجلب رابط المشاركة حقل URL مفردًا إلى جانب Result.