مرجع FlipLink API

الملف الشخصي

من أنا

تُرجع الحساب الذي يملك مفتاح الـ API — معرّفات المستخدم/البائع، والاسم، والبريد الإلكتروني، والعلامة التجارية، ورابط التطبيق، والحد الأقصى لحجم الرفع في الباقة (MaxFileSizeMB).

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

المتطلبات المسبقة — لا شيء. هذا هو الاستدعاء الجذري: فهو يصادق مفتاح الـ API لديك، وهو المتطلب المسبق لكل واجهة أخرى.

لا توجد معاملات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

GET/api/whoami

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

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

جلب الملف الشخصي

تُرجع ملف الحساب الخاص بمفتاح الـ API — الاسم الظاهر، والهاتف، ورابط صورة الملف الشخصي.

GEThttps://go.fliplink.me/api/get-profile

المتطلبات المسبقةمن أنا(مفتاح API صالح)→جلب الملف الشخصي

لا توجد معاملات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةتحديث الملف الشخصي (جزئي)من أنا

GET/api/get-profile

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

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

تحديث الملف الشخصي (جزئي)

تحديث جزئي — الحقول المحذوفة تبقى بقيمها الحالية. يلزم حقل واحد على الأقل.

PUThttps://go.fliplink.me/api/set-profile

المتطلبات المسبقةمن أنا(مفتاح API صالح)→تحديث الملف الشخصي (جزئي)

معاملات الجسم

`Name`	مثل `Mark Stevens`
`Phone`phone	مثل `+14155550142`
`ProfileImage`URL	مثل `https://...`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةجلب الملف الشخصي

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://...'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الجسم

Name

Phonephone

ProfileImageURL

الاشتراك والمدفوعات

جلب تفاصيل الاشتراك

تُرجع باقتك الحالية وحصتك — اسم الباقة، والحالة، والرسوم، وتاريخ الفاتورة التالية، والحد الأقصى لحجم الملف، والحد الأقصى للعناصر/أسماء CNAME، وأعلام المزايا.

GEThttps://go.fliplink.me/api/get-subscription-details

المتطلبات المسبقةمن أنا(مفتاح API صالح)→جلب تفاصيل الاشتراك

لا توجد معاملات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةقائمة المدفوعات من أنا

GET/api/get-subscription-details

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

مثال على الاستجابة200 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"
  }
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

قائمة المدفوعات

تُرجع سجل فوترتك — كل عملية شراء/تجديد للباقة مع معرّف الطلب، والمبلغ، والباقة، والتاريخ، وعدد العناصر.

GEThttps://go.fliplink.me/api/list-payments

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة المدفوعات

لا توجد معاملات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةجلب تفاصيل الاشتراك

GET/api/list-payments

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

مثال على الاستجابة200 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
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

العناصر — إنشاء

إنشاء من ملف

تُنشئ كتيبًا (أو مستندًا) من ملف PDF مرفوع، يُرسَل بصيغة multipart/form-data. يُخزَّن الملف، وتُنشأ صورة مصغّرة، ويُسجَّل السجل.

ملاحظات
- يتحدد ما إذا كنت ستحصل على كتيب أو مستند عبر ترويسة Host في الطلب — go.fliplink.me (الافتراضي) تُرجع كتيبات، وgo.doclink.me تُرجع مستندات.
- تعكس *_Count / *_Max / *_Left حصة باقتك بعد هذا الإنشاء.
- استخدم الـ ID المُرجَع في الطلبات اللاحقة (set-meta، وset-cta-primary، وsave-as-template، إلخ).
- الحد الأقصى لحجم الملف يعتمد على الباقة (راجع MaxFileSizeMB من who-am-i).

POSThttps://go.fliplink.me/api/create-by-file

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف

الجسم (multipart/form-data)

`File`file	—
`Name`	مثل `My Document`
`Title`	مثل `My Title`
`DocType`enum	كتيب أو مستند. على go.doclink.me يُعامَل دائمًا كمستند.واحد من: `Flipbook`, `Document`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

الجسم (form-data)

Filefile

Name

Title

DocTypechoose oneكتيب أو مستند. على go.doclink.me يُعامَل دائمًا كمستند.

إنشاء من رابط

تُنشئ كتيبًا (أو مستندًا) من رابط PDF. يُنزّل الخادم FileURL، ويرفعه إلى S3، وينشئ صورة مصغّرة، ويسجّل السجل.

ملاحظات
- تتحدد بادئة اسم الحقل Flipbooks_* مقابل Documents_* عبر ترويسة Host في الطلب — go.fliplink.me (الافتراضي) تُرجع كتيبات، وgo.doclink.me تُرجع مستندات.
- تعكس *_Count / *_Max / *_Left حصة باقة الحساب بعد هذا الإنشاء.
- يجب أن يستجيب الرابط المصدر خلال 60 ثانية — المصادر البطيئة أو غير المتاحة تفشل بالرسالة Source URL timed out after 60s. وللمصادر غير الموثوقة، يُفضَّل استخدام /api/create-by-file.

POSThttps://go.fliplink.me/api/create-by-url

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من رابط

معاملات الجسم

`FileURL`URL	مثل `https://example.com/document.pdf`
`Name`	مثل `My Document`
`Title`	مثل `My Title`
`DocType`enum	مثل `Flipbook`واحد من: `Flipbook`, `Document`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الجسم

FileURLURL

Name

Title

DocTypechoose one

العناصر — قراءة

جلب عنصر واحد

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

GEThttps://go.fliplink.me/api/get/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→جلب عنصر واحد

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

GET/api/get/{flipbookId}

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

مثال على الاستجابة200 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"
  }
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

البحث عبر الرابط

يبحث عن كتيب حسب رابطه العام/رابط المشاركة ويُرجع سجله الكامل (بالشكل نفسه لـ get).

GEThttps://go.fliplink.me/api/find-by-url

المتطلبات المسبقةمن أنا(مفتاح API صالح)→البحث عبر الرابط

معاملات الاستعلام

URLURL رابط العارض الكامل، أو رابط CNAME، أو مجرد لاحقة CustomURL المجرّدة. يأخذ الخادم آخر مقطع من المسار كاللاحقة.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 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"
  }
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

URLURLرابط العارض الكامل، أو رابط CNAME، أو مجرد لاحقة CustomURL المجرّدة. يأخذ الخادم آخر مقطع من المسار كاللاحقة.

قائمة

تسرد كتيباتك/مستنداتك مع التصفّح (PageNo/PageSize). يتضمن كل عنصر المعرّفات، والعنوان، والروابط، وعدد المشاهدات/العملاء المحتملين/المبيعات، والمجلد، وأعلام الحالة.

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

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة

معاملات الاستعلام

`Folder`	—
`SearchText`	—
`PageNo`number	مثل `1`
`PageSize`number	مثل `25`
`Offset`number	مثل `0`
`SortBy`enum	اختياري. واحد من: `Name`، `DocType`، `CreatedOn`، `NoOfViews`، `NoOfLeads`. الفراغ = الترتيب الافتراضي؛ والقيم غير المعروفة تعود إلى الافتراضي.واحد من: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`
`SortOrder`enum	اختياري. `ASC` أو `DESC`. يُتجاهَل إذا كانت SortBy فارغة. والقيم غير المعروفة تعود بصمت إلى الافتراضي.واحد من: `ASC`, `DESC`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 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
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

Folder

SearchText

PageNonumber

PageSizenumber

Offsetnumber

SortBychoose oneاختياري. واحد من: `Name`، `DocType`، `CreatedOn`، `NoOfViews`، `NoOfLeads`. الفراغ = الترتيب الافتراضي؛ والقيم غير المعروفة تعود إلى الافتراضي.

SortOrderchoose oneاختياري. `ASC` أو `DESC`. يُتجاهَل إذا كانت SortBy فارغة. والقيم غير المعروفة تعود بصمت إلى الافتراضي.

جلب رابط PDF

تُرجع رابط S3 العام لملف PDF الرئيسي للعنصر (النسخة المدمجة إذا كان مغلّفًا بصفحات أمامية/خلفية).

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→جلب رابط PDF

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

GET/api/get-pdf/{flipbookId}

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

مثال على الاستجابة200 OK

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

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

جلب رابط المشاركة

تُرجع رابط العارض العام للكتيب (بادئة النطاق المخصص/المضيف الخاصة به مع لاحقة مشاركة الكتيب).

الاستجابة: { "Result": "OK", "URL": "https://go.fliplink.me/view/<guid>" }.

GEThttps://go.fliplink.me/api/get-share-link/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→جلب رابط المشاركة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةجلب عنصر واحد ضبط الرابط المخصص

GET/api/get-share-link/{flipbookId}

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

مثال على الاستجابة200 OK

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

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

العناصر — تعديل

تكرار

تُنشئ نسخة أو أكثر من الكتيب على جانب الخادم — كل نسخة تحصل على ID جديد خاص بها ورابط مشاركة URL. يمكنك تكرار حتى 20 نسخة دفعة واحدة (Count).

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→تكرار

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Countnumber من 1 إلى 500 (يُقيَّد على جانب الخادم)

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Countnumberمن 1 إلى 500 (يُقيَّد على جانب الخادم)

استبدال PDF (ملف)

رفع متعدد الأجزاء. يُعيد الدمج تلقائيًا مع الصفحات الأمامية/الخلفية الحالية إذا كانت مرفقة.

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→استبدال PDF (ملف)

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

الجسم (multipart/form-data)

Filefile —

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

الجسم (form-data)

Filefile

استبدال PDF (رابط)

تستبدل ملف PDF الخاص بكتيب موجود بآخر يُنزّله الخادم من رابط تقدّمه. يحتفظ الكتيب بمعرّفه وإعداداته ورابط المشاركة.

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→استبدال PDF (رابط)

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

FileURL مثل https://example.com/new.pdf

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

FileURL

الحفظ كقالب (تبديل)

تضع علامة على الكتيب كقالب قابل لإعادة الاستخدام (Status=true) أو تزيله من القوالب (Status=false). تظهر القوالب في list-templates ويمكن استخدامها لإنشاء كتيبات جديدة.

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→الحفظ كقالب (تبديل)

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Statustrue | false true/false. الافتراضي true عند الحذف.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Saved as template"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Statustrue / falsetrue/false. الافتراضي true عند الحذف.

الإسناد إلى مجلد

تنقل الكتيب إلى مجلد للتنظيم. تُنشأ المجلدات عند الطلب — أسنِد إلى اسم مجلد غير موجود بعد ويُنشأ تلقائيًا (لا يوجد طلب منفصل لـ 'إنشاء مجلد'). أرسِل Folder فارغًا لإزالة الكتيب من مجلده. يوجد المجلد فقط طالما يحتوي على كتيب واحد على الأقل، لذا فإن نقل آخر كتيب منه يجعله يختفي من list-folders. قد تحتوي أسماء المجلدات على / (مثل Marketing/Q2).

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→الإسناد إلى مجلد

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Folder اسم المجلد المراد نقل الكتيب إليه — يُنشأ إن لم يكن موجودًا (أو أعِد استخدام اسم من list-folders). أرسِل فارغًا لإلغاء الإسناد.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Folderاسم المجلد المراد نقل الكتيب إليه — يُنشأ إن لم يكن موجودًا (أو أعِد استخدام اسم من list-folders). أرسِل فارغًا لإلغاء الإسناد.

ضبط الصفحة الأمامية/الخلفية (ملف)

كلا الصفحتين الأمامية/الخلفية اختياري — يلزم واحدة على الأقل. يُعيد الدمج مع ملف PDF الرئيسي الحالي.

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الصفحة الأمامية/الخلفية (ملف)

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

الجسم (multipart/form-data)

`Front`file	—
`Back`file	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

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

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

الجسم (form-data)

Frontfile

Backfile

ضبط الصفحة الأمامية/الخلفية (رابط)

نسخة الرابط من set-front-back-page — تُرفق صفحات الغلاف/الخلفية من رابط PDF بعيد بدلًا من ملف مرفوع.

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الصفحة الأمامية/الخلفية (رابط)

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`Front`URL	مثل `https://example.com/front.pdf`
`Back`URL	مثل `https://example.com/back.pdf`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

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

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

FrontURL

BackURL

إزالة الصفحة الأمامية/الخلفية

تزيل غلاف الصفحة الأمامية/الخلفية، لتعيد FilePDF إلى ملف PDF الأساسي غير المغلّف (MiddlePDF). عملية لا تتأثر بالتكرار — الكتيب الذي بلا غلاف يُرجع OK ولا يغيّر شيئًا. تُرجع { Result, Message, URL (رابط S3 لملف PDF الأساسي) }. كائنات S3 القديمة المدمجة/الأمامية/الخلفية لا تُحذف.

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→إزالة الصفحة الأمامية/الخلفية

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

ضبط الانتهاء / إزالة الانتهاء

تضبط أو تزيل الانتهاء التلقائي للكتيب. أرسِل Days + Hours كأعداد صحيحة؛ Days=-1, Hours=0 يزيل الانتهاء بالكامل.

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الانتهاء / إزالة الانتهاء

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`Days`number	استخدم -1 لإزالة الانتهاء
`Hours`number	اختياري، الافتراضي 0

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Daysnumberاستخدم -1 لإزالة الانتهاء

Hoursnumberاختياري، الافتراضي 0

تثبيت العنصر (تبديل)

تثبّت الكتيب أو تلغي تثبيته (حالة النجمة) ليُرتَّب أعلى لوحة التحكم.

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→تثبيت العنصر (تبديل)

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةقائمة

PUT/api/set-pin/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

العناصر — حذف

حذف

تحذف سجل قاعدة بيانات الكتيب نهائيًا. ملاحظة: ملفات S3 الأساسية لا تُزال تلقائيًا.

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→حذف

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

DELETE/api/delete/{flipbookId}

curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

CNAME (النطاقات المخصصة)

إضافة CNAME

تربط نطاقًا مخصصًا (CNAME) سبق تفعيله بكتيب. يجب أولًا إضافة النطاق والتحقق منه عبر لوحة التحكم على الويب (التي تهيّئ DNS + SSL)؛ هذه الواجهة تثبّت الربط فقط — فهي لا تتحقق من DNS ولا تصدر شهادات.

المتطلبات المسبقة:
- يجب أن يكون CNAME موجودًا بالفعل في حسابك (مُضافًا عبر لوحة التحكم). وإلا: Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- يجب أن يكون ضمن حد CNAME في باقتك.

المعطيات:
- CNAME (مطلوب) — اسم المضيف الكامل، مثل docs.example.com
- IsCloudflare (اختياري، الافتراضي 0).

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→إضافة CNAME

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`CNAME`	مثل `docs.example.com`
`IsCloudflare`true \| false	اختياري. 0 (الافتراضي) أو 1. مرّر 1 إذا كان DNS لديك خلف وكيل Cloudflare.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

CNAME

IsCloudflaretrue / falseاختياري. 0 (الافتراضي) أو 1. مرّر 1 إذا كان DNS لديك خلف وكيل Cloudflare.

قائمة CNAMEs

كل نطاقات CNAME المخصصة للمتصل. كل عنصر: { CNAME, Documents (عدد الكتيبات النشطة), FlipbookIDs ([...] لمعرّفات الكتيبات النشطة المرتبطة بذلك CNAME) }.

GEThttps://go.fliplink.me/api/list-cnames

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة CNAMEs

لا توجد معاملات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةإضافة CNAME حذف CNAME

GET/api/list-cnames

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

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

حذف CNAME

تزيل ربط نطاق مخصص (CNAME) من كتيب واحد أو من كل كتيباتك. وضعان:

جماعي (الافتراضي): مرّر CNAME=<host> واترك FlipbookID فارغًا — يزيل ذلك CNAME من كل كتيب تملكه.
لكل كتيب: مرّر FlipbookID=<id> — يُستخرَج CNAME من ذلك الكتيب. استخدم هذا لإجراء 'إزالة CNAME' لكل صف.

الاستجابة (لكل كتيب): { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
الاستجابة (جماعي): { "Result": "OK", "Message": "CNAME removed successfully" }
كلاهما مفقود: { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

ملاحظة: مرّر CNAME كمعامل استعلام (لا كمقطع مسار) لتجنّب المشكلات مع النقاط في اسم المضيف.

DELETEhttps://go.fliplink.me/api/delete-cname

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة CNAMEs(ابحث عن CNAME / FlipbookID)→حذف CNAME

معاملات الاستعلام

`CNAME`	مطلوب للوضع الجماعي (يزيل CNAME من كل كتيب تملكه). يُتجاهَل عندما يكون FlipbookID > 0 — إذ يُؤخَذ CNAME من ذلك الكتيب بدلًا من ذلك.
`FlipbookID`number	اختياري. مرّر معرّف كتيب > 0 لإزالة CNAME من ذلك الكتيب فقط (وضع لكل كتيب). اتركه فارغًا/محذوفًا/0 للوضع الجماعي (الإزالة من الكل).

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةإضافة CNAME قائمة CNAMEs

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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

CNAMEمطلوب للوضع الجماعي (يزيل CNAME من كل كتيب تملكه). يُتجاهَل عندما يكون FlipbookID > 0 — إذ يُؤخَذ CNAME من ذلك الكتيب بدلًا من ذلك.

FlipbookIDnumberاختياري. مرّر معرّف كتيب > 0 لإزالة CNAME من ذلك الكتيب فقط (وضع لكل كتيب). اتركه فارغًا/محذوفًا/0 للوضع الجماعي (الإزالة من الكل).

المجلدات

قائمة المجلدات

تسرد مجلداتك، كلٌّ بالشكل { Folder (الاسم), URL (معرّف GUID للمجلد) }. تُشتق المجلدات من إسنادات الكتيبات (المنشأة عبر assign-to-folder)، لذا لا يُدرَج المجلد الفارغ. تغذّي أسماء المجلدات كلًّا من assign-to-folder (لوضع كتيب) وset-team-member (لتحديد نطاق وصول عضو الفريق).

GEThttps://go.fliplink.me/api/list-folders

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة المجلدات

لا توجد معاملات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

GET/api/list-folders

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

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

أعضاء الفريق

قائمة أعضاء الفريق

تسرد أعضاء الفريق (مستخدمي البائع) في حسابك مع تفاصيل وصولهم، بما في ذلك المجلدات المُسنَدة إلى كل عضو. لا تُرجَع كلمات المرور أبدًا. صفِّ النتائج حسب IsActive.

GEThttps://go.fliplink.me/api/list-team-members

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة أعضاء الفريق

معاملات الاستعلام

IsActivetrue | false 1=نشط (الافتراضي)، 0=غير نشط

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

IsActivetrue / false1=نشط (الافتراضي)، 0=غير نشط

جلب عضو الفريق

تُرجع عضو فريق واحدًا حسب معرّف العضو (الـ ID من list-team-members) — الاسم، والبريد الإلكتروني، وحالة النشاط، والمجلدات المُسنَدة إلى العضو. عضو الفريق مقيَّد بالمجلدات المضبوطة عبر set-team-member (حقل Folders)، فلا يصل إلا إلى الكتيبات داخل تلك المجلدات. لا تُرجَع كلمات المرور أبدًا. الـ memberId هو معرّف عضو الفريق (من List Team Members) — وليس معرّف كتيب؛ تمرير معرّف كتيب يُرجع "Team member not found". يُرجَع العضو داخل كائن Item؛ وFolders قائمة مفصولة بفواصل بالمجلدات التي يمكنه الوصول إليها (الفراغ = لا قيود على المجلدات).

GEThttps://go.fliplink.me/api/get-team-member/{memberId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→ضبط عضو الفريق (إنشاء أو تحديث)(أنشئ عضوًا أولًا)→جلب عضو الفريق

معاملات المسار

memberIdnumber معرّف عضو الفريق (من list-team-members). وليس معرّف كتيب.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

memberIdrequirednumberمعرّف عضو الفريق (من list-team-members). وليس معرّف كتيب.

ضبط عضو الفريق (إنشاء أو تحديث)

تُنشئ عضو فريق جديدًا (مستخدم بائع) أو تحدّث عضوًا قائمًا — تتحكم في من يصل إلى حسابك و، عبر حقل Folders، بالمجلدات التي يقتصر عليها (لا يرى العضو إلا الكتيبات داخل مجلداته المُسنَدة). يُكتَب قيد في سجل التدقيق عند النجاح.

أخطاء شائعة: اسم العضو هو حقل Name واحد — لا يوجد FirstName/LastName. وFolders قائمة مفصولة بفواصل بأسماء المجلدات من List Folders (مثل Marketing,Sales)؛ اتركها فارغة لعدم وجود قيود على المجلدات. إنشاء عضو يُرجع { Result:"OK", Message:"Team member created" } (مسار التحديث — عند تمرير ID — يُرجع "Updated successfully"). يجب ألا ينتمي بريد العضو الإلكتروني إلى مستخدم FlipLink موجود، وتُرفَض عناوين البريد المضاف إليها +.

POSThttps://go.fliplink.me/api/set-team-member

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة المجلدات(أسماء لنطاق Folders)→ضبط عضو الفريق (إنشاء أو تحديث)

معاملات الجسم

`Name`	مثل `Jane`
`Email`email	مثل `jane@example.com`
`ID`number	احذفه أو مرّر -1 للإنشاء. >0 للتحديث.
`Password`	نص صريح؛ يُشفَّر على جانب الخادم. تركه فارغًا عند التحديث يُبقي القيمة الحالية.
`ProfileImage`URL	—
`Folders`	المجلدات التي يقتصر عليها هذا العضو — قائمة محدّدة بأسماء المجلدات (من list-folders). لا يصل العضو إلا إلى الكتيبات داخل هذه المجلدات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Team member created"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الجسم

Name

Emailemail

IDnumberاحذفه أو مرّر -1 للإنشاء. >0 للتحديث.

Passwordنص صريح؛ يُشفَّر على جانب الخادم. تركه فارغًا عند التحديث يُبقي القيمة الحالية.

ProfileImageURL

Foldersالمجلدات التي يقتصر عليها هذا العضو — قائمة محدّدة بأسماء المجلدات (من list-folders). لا يصل العضو إلا إلى الكتيبات داخل هذه المجلدات.

ضبط نشاط عضو الفريق

تفعّل عضو فريق أو تعطّله، متحكّمةً في إمكانية تسجيل دخوله ووصوله إلى الحساب.

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→ضبط عضو الفريق (إنشاء أو تحديث)(أنشئ عضوًا أولًا)→ضبط نشاط عضو الفريق

معاملات المسار

memberIdnumber معرّف عضو الفريق (من list-team-members). وليس معرّف كتيب.

معاملات الجسم

IsActivetrue | false مثل true

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

memberIdrequirednumberمعرّف عضو الفريق (من list-team-members). وليس معرّف كتيب.

معاملات الجسم

IsActivetrue / false

حذف عضو الفريق

حذف ناعم (تعطيل). لا يُحذَف أعضاء الفريق نهائيًا أبدًا — هذا يعطّل العضو (اسم بديل بأسلوب REST لـ set-team-member-active مع IsActive=false). يبقى سجل مدفوعاته ومراجع التدقيق سليمة، ويمكن إعادة تفعيله لاحقًا عبر PUT /api/set-team-member-active (IsActive=true).

الاستجابة: { "Result": "OK", "Message": "Team member deactivated" }.

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→ضبط عضو الفريق (إنشاء أو تحديث)(أنشئ عضوًا أولًا)→حذف عضو الفريق

معاملات المسار

memberIdnumber معرّف عضو الفريق (من list-team-members). وليس معرّف كتيب.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

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

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

memberIdrequirednumberمعرّف عضو الفريق (من list-team-members). وليس معرّف كتيب.

العملاء المحتملون والمبيعات

قائمة العملاء المحتملين

تسرد بيانات العملاء المحتملين الملتقطة عبر كتيباتك. تُرجع Items[] بالإضافة إلى مخطط Columns[] ديناميكي (لعرض جدول) وTotalRecordCount. تدعم التصفّح والتصدير إلى CSV عبر IsDownload.

GEThttps://go.fliplink.me/api/list-leads

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة العملاء المحتملين

معاملات الاستعلام

`ItemIDs`	معرّفات كتيبات مفصولة بفاصلة أو بشرطة عمودية (الفراغ = الكل)
`SearchText`	—
`PageNo`number	مثل `1`
`Offset`number	مثل `0`
`IsDownload`true \| false	مثل `true`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 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
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

ItemIDsمعرّفات كتيبات مفصولة بفاصلة أو بشرطة عمودية (الفراغ = الكل)

SearchText

PageNonumber

Offsetnumber

IsDownloadtrue / false

قائمة المبيعات

تسرد سجلات البيع/الشراء لكتيباتك (بريد المشتري، والكتيب، والمبلغ، والتاريخ) بالإضافة إلى تعريفات الأعمدة لجدول المبيعات. تدعم التصفّح والتصدير إلى CSV عبر IsDownload.

GEThttps://go.fliplink.me/api/list-sales

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة المبيعات

معاملات الاستعلام

`ItemIDs`	—
`SearchText`	—
`PageNo`number	مثل `1`
`Offset`number	مثل `0`
`IsDownload`true \| false	مثل `true`
`IsAbandoned`true \| false	true ← تُرجع مبيعات السلة المتروكة بدلًا من المبيعات المكتملة

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 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
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

ItemIDs

SearchText

PageNonumber

Offsetnumber

IsDownloadtrue / false

IsAbandonedtrue / falsetrue ← تُرجع مبيعات السلة المتروكة بدلًا من المبيعات المكتملة

حذف عميل محتمل

تحذف عميلًا محتملًا واحدًا ملتقطًا حسب معرّفه. مقطع المسار هو الـ leadId؛ مرّر أيضًا Email العميل وFlipbookID الخاص به كمعاملي استعلام.

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة العملاء المحتملين(احصل على معرّف عميل محتمل)→حذف عميل محتمل

معاملات المسار

leadIdnumber معرّف العميل المحتمل (الـ LeadID من list-leads).

معاملات الاستعلام

`Email`email	مثل `foo@example.com`
`FlipbookID`number	مثل `{{flipbookId}}`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

leadIdrequirednumberمعرّف العميل المحتمل (الـ LeadID من list-leads).

معاملات الاستعلام

Emailemail

FlipbookIDnumber

حذف العملاء المحتملين (جماعي)

حذف جماعي للعملاء المحتملين حسب المرشِّح. يلزم واحد على الأقل من FlipbookID/Email/DateFrom/DateTo — يُرفَض الاستدعاء بلا مرشِّح (لا يوجد مسار 'حذف الكل'). مقيَّد دائمًا بنطاق البائع. تُرجع { Result, Deleted (العدد) }. تنظّف الصفوف الفرعية أيضًا (سجل المشاهدات / نقرات CTA / سجل تصدير الجداول).

DELETEhttps://go.fliplink.me/api/delete-leads

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(حدّد النطاق عبر FlipbookID)→حذف العملاء المحتملين (جماعي)

معاملات الاستعلام

`FlipbookID`number	اختياري. احذف العملاء المحتملين على هذا الكتيب فقط.
`Email`email	اختياري. تطابق تام للبريد الإلكتروني.
`DateFrom`	اختياري. احذف العملاء المحتملين الملتقطين في/بعد هذا التاريخ (يطابق Lead.CreatedOn). أي تاريخ قابل للتحليل، مثل 2026-01-01 أو 2026-01-01T00:00:00Z.
`DateTo`	اختياري. احذف العملاء المحتملين الملتقطين في/قبل هذا التاريخ.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

FlipbookIDnumberاختياري. احذف العملاء المحتملين على هذا الكتيب فقط.

Emailemailاختياري. تطابق تام للبريد الإلكتروني.

DateFromاختياري. احذف العملاء المحتملين الملتقطين في/بعد هذا التاريخ (يطابق Lead.CreatedOn). أي تاريخ قابل للتحليل، مثل 2026-01-01 أو 2026-01-01T00:00:00Z.

DateToاختياري. احذف العملاء المحتملين الملتقطين في/قبل هذا التاريخ.

تسجيل شراء كتيب

تسجّل عملية بيع (شراء) مكتملة لكتيب — استخدمها لتدوين المشتريات التي تتم عبر مسار الدفع الخاص بك، دون المرور بدفع FlipLink عبر Stripe.

معامل المسار: {flipbookId} — الكتيب الذي يُعلَّم كمُشترى.

الجسم (urlencoded):
- Email — بريد المشتري (مطلوب)
- PaymentRef — مرجع بوابة الدفع لديك، مثل معرّف Stripe PaymentIntent (مطلوب)

الاستجابة (نجاح): { "Result": "OK", "Message": "Purchase recorded successfully" }
الاستجابة (خطأ): { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

أخطاء شائعة: أرسِل PaymentRef؛ ولا ترسل Amount/Currency — فهي تُشتق على جانب الخادم من مرجع الدفع لديك.

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→تسجيل شراء كتيب

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`Email`email	البريد الإلكتروني للمشتري (مطلوب).
`PaymentRef`	مرجع نية الدفع من البوابة (مطلوب). في Stripe، هذا هو معرّف PaymentIntent (`pi_...`).

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Emailemailالبريد الإلكتروني للمشتري (مطلوب).

PaymentRefمرجع نية الدفع من البوابة (مطلوب). في Stripe، هذا هو معرّف PaymentIntent (`pi_...`).

عمليات البحث

قائمة القوالب

تسرد قوالب الكتيبات القابلة لإعادة الاستخدام المحفوظة في حسابك. صفِّ حسب DocType (0 = الكل). استخدم الـ ID لقالب مع مسارات save-as-template / الإنشاء.

GEThttps://go.fliplink.me/api/list-templates

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة القوالب

معاملات الاستعلام

DocTypenumber 0 = كتيب (الافتراضي)، 1 = مستند

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةالحفظ كقالب (تبديل)إنشاء من ملف

GET/api/list-templates

curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \  -H 'X-Api-Key: YOUR_API_KEY'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

DocTypenumber0 = كتيب (الافتراضي)، 1 = مستند

قائمة السمات

تسرد سمات/ثيمات العارض المتاحة؛ يحمل كل صف رابط الخلفية المرفقة بالسمة. استخدم اسم السمة مع set-skin.

GEThttps://go.fliplink.me/api/list-skins

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة السمات

معاملات الاستعلام

Typetrue | false 0=سمات الكتيب، 1=سمات المستند

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةضبط السمة

GET/api/list-skins

curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \  -H 'X-Api-Key: YOUR_API_KEY'

مثال على الاستجابة200 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"
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات الاستعلام

Typetrue / false0=سمات الكتيب، 1=سمات المستند

قائمة العملات

تسرد العملات المتاحة عند بيع كتيب (لإعدادات البيع/الدفع).

GEThttps://go.fliplink.me/api/list-currencies

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة العملات

لا توجد معاملات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةضبط إعدادات البيع

GET/api/list-currencies

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

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

قائمة الموسيقى الخلفية

تسرد مقاطع الموسيقى الخلفية المدمجة التي يمكنك إرفاقها بعارض الكتيب.

GEThttps://go.fliplink.me/api/list-background-music

المتطلبات المسبقةمن أنا(مفتاح API صالح)→قائمة الموسيقى الخلفية

لا توجد معاملات.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةضبط الموسيقى الخلفية

GET/api/list-background-music

curl -X GET 'https://go.fliplink.me/api/list-background-music' \  -H 'X-Api-Key: YOUR_API_KEY'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

الأقسام — العلامة التجارية والمحتوى

ضبط البيانات الوصفية

تضبط عنوان الكتيب وبياناته الوصفية لمحركات البحث — Title، وDescription، وTitleColor، وعلم IsPublished.

ملاحظة: هذا يستبدل Title/Description/TitleColor. لتغيير حالة النشر فقط، استخدم set-published.

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط البيانات الوصفية

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`Title`	—
`Description`	—
`TitleColor`	—
`IsPublished`true \| false	مثل `false`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

Title

Description

TitleColor

IsPublishedtrue / false

ضبط النشر (نشر / إلغاء نشر)

تنشر الكتيب أو تلغي نشره — تبدّل علم النشر فقط، مع إبقاء Title/Description/TitleColor دون تغيير (على عكس set-meta). استخدمها لإعادة نشر كتيب، مثل كتيب عاد غير منشور من create-by-file.

PUThttps://go.fliplink.me/api/set-published/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط النشر (نشر / إلغاء نشر)

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsPublishedtrue | false true/1 = نشر، false/0 = إلغاء نشر (مطلوب).

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةضبط البيانات الوصفية

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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsPublishedtrue / falsetrue/1 = نشر، false/0 = إلغاء نشر (مطلوب).

ضبط السمة

تطبّق سمة/ثيم العارض على الكتيب؛ يحوّل الخادم اسم السمة إلى معرّفها.

أخطاء شائعة: الحقل هو SkinName (النص من list-skins)، وليس معرّفًا رقميًا.

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→قائمة السمات(اختر SkinName)→ضبط السمة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

SkinName من /api/list-skins ← عمود Name

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةقائمة السمات

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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

SkinNameمن /api/list-skins ← عمود Name

ضبط الشعار

تضبط صورة الشعار المعروضة في منطقة الترويسة/العلامة التجارية لعارض الكتيب.

PUThttps://go.fliplink.me/api/set-logo/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الشعار

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`LogoIMG`URL	—
`LogoURL`URL	—
`IsShowLogoMobile`true \| false	مثل `false`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

PUT/api/set-logo/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-logo/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LogoIMG=<LogoIMG>' \
  --data-urlencode 'LogoURL=<LogoURL>' \
  --data-urlencode 'IsShowLogoMobile=false'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

LogoIMGURL

LogoURLURL

IsShowLogoMobiletrue / false

ضبط صورة الخلفية

تضبط خلفية العارض من رابط تقدّمه (لا يوجد معرض مدمج).

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط صورة الخلفية

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

BackgroundIMGURL رابط صورة أو رابط نائب مثل https://plchldr.co/i/100x100?text=&bg=HEX

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

BackgroundIMGURLرابط صورة أو رابط نائب مثل https://plchldr.co/i/100x100?text=&bg=HEX

ضبط الأيقونة المفضّلة

تضبط الأيقونة المفضّلة (أيقونة تبويب المتصفح) المستخدمة في صفحة العارض المستضافة للكتيب.

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الأيقونة المفضّلة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

FaviconIMGURL —

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةضبط الشعار

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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

FaviconIMGURL

ضبط مظهر الصفحة

تهيّئ مظهر صفحة العارض — الخلفية، وظل الصفحة، والتباعد، والخيارات المرتبطة بالمظهر العام. تُخزَّن القيم حرفيًا؛ وقد تُرجع العناصر الأقدم قيمًا أخرى (مثل regular، أو 1 الرقمية) عند قراءتها عبر Get one.

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط مظهر الصفحة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`PageDepth`enum	flat \| thin \| thickواحد من: `flat`, `thin`, `thick`
`CoverType`enum	soft \| hardواحد من: `soft`, `hard`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

PageDepthchoose oneflat | thin | thick

CoverTypechoose onesoft | hard

ضبط نص التحميل

تضبط النص المخصص المعروض على شاشة تحميل العارض.

أخطاء شائعة: الحقل هو CustomLoadingText، وليس LoadingText.

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط نص التحميل

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

CustomLoadingText —

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

CustomLoadingText

ضبط الرابط المخصص

تضبط اللاحقة المخصصة (vanity) لرابط مشاركة الكتيب. يجب أن تكون فريدة؛ واللاحقة المستخدمة بالفعل تُرجع Result:ERROR.

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الرابط المخصص

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

CustomURL —

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةجلب رابط المشاركة إضافة CNAME

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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

CustomURL

ضبط PDF المعاينة

تضبط ملف PDF المعاينة المعروض للقرّاء قبل التقاط بياناتهم / الدفع. يُمسَح تلقائيًا إذا كان كلٌّ من التقاط العملاء المحتملين ووضع البيع متوقفًا.

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط PDF المعاينة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

PreviewPDFURL —

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

PreviewPDFURL

ضبط PDF الصور

تضبط ملف PDF الخاص بالصور/المعاينة المستخدم للصور المصغّرة والمعاينات. أرسِل فارغًا للإبقاء على ملف PDF الصور الحالي.

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط PDF الصور

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IMGPdfURL —

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةضبط PDF المعاينة

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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IMGPdfURL

الأقسام — العارض والقارئ

ضبط أدوات تحكم العارض

تُظهر أو تُخفي أزرار شريط أدوات العارض كلًّا على حدة (التنزيل، والطباعة، والمشاركة، وملء الشاشة، والتكبير، والصور المصغّرة، إلخ).

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط أدوات تحكم العارض

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsShowControls`true \| false	مثل `true`
`IsPrint`true \| false	مثل `false`
`IsDownload`true \| false	مثل `false`
`IsThumbnails`true \| false	مثل `true`
`IsSearch`true \| false	مثل `true`
`IsSound`true \| false	مثل `true`
`IsFullscreen`true \| false	مثل `true`
`IsZoom`true \| false	مثل `true`
`IsNotes`true \| false	مثل `false`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsShowControlstrue / false

IsPrinttrue / false

IsDownloadtrue / false

IsThumbnailstrue / false

IsSearchtrue / false

IsSoundtrue / false

IsFullscreentrue / false

IsZoomtrue / false

IsNotestrue / false

ضبط تنقّل القارئ

تهيّئ تنقّل القارئ في العارض — الصور المصغّرة للصفحات، وجدول المحتويات، وكيفية انتقال القرّاء بين الصفحات.

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط تنقّل القارئ

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsNavFirstLast`true \| false	مثل `true`
`BookLayout`enum	1=مفردة، 2=مزدوجةواحد من: `1`, `2`
`IsRightToLeft`true \| false	مثل `false`
`ScrollBehaviour`number	وضع تمرير رقمي

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsNavFirstLasttrue / false

BookLayoutchoose one1=مفردة، 2=مزدوجة

IsRightToLefttrue / false

ScrollBehaviournumberوضع تمرير رقمي

ضبط التقليب التلقائي

تفعّل أو تعطّل التقليب التلقائي للصفحات في العارض وفترته الزمنية.

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقليب التلقائي

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

AutoFlipInSecsnumber بالميلي ثانية رغم الاسم. 0 = إيقاف، 3000 = 3 ثوانٍ، 5000 = 5 ثوانٍ، إلخ.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

AutoFlipInSecsnumberبالميلي ثانية رغم الاسم. 0 = إيقاف، 3000 = 3 ثوانٍ، 5000 = 5 ثوانٍ، إلخ.

ضبط الموسيقى الخلفية

تضبط أو تمسح مقطع الموسيقى الخلفية الذي يُشغَّل في العارض. راجع list-background-music للمقاطع المتاحة.

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→قائمة الموسيقى الخلفية(اختر مقطعًا)→ضبط الموسيقى الخلفية

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`BackgroundMusic`	اسم ملف مقطع محدد مسبقًا (من /api/list-background-music)
`BackgroundMusicCustom`URL	رابط موسيقى مرفوعة مخصصة
`IsBackgroundMusicLoop`true \| false	مثل `false`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

BackgroundMusicاسم ملف مقطع محدد مسبقًا (من /api/list-background-music)

BackgroundMusicCustomURLرابط موسيقى مرفوعة مخصصة

IsBackgroundMusicLooptrue / false

ضبط تخطيط الترويسة/التذييل

تضبط المحتوى المعروض في الأركان الأربعة (الترويسة/التذييل) لإطار العارض.

PUThttps://go.fliplink.me/api/set-header-footer-layout/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط تخطيط الترويسة/التذييل

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`TopLeft`	—
`TopRight`	—
`BottomLeft`	—
`BottomRight`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

PUT/api/set-header-footer-layout/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=<TopLeft>' \
  --data-urlencode 'TopRight=<TopRight>' \
  --data-urlencode 'BottomLeft=<BottomLeft>' \
  --data-urlencode 'BottomRight=<BottomRight>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

TopLeft

TopRight

BottomLeft

BottomRight

الأقسام — أزرار الحث على الإجراء

ضبط زر الحث الأساسي

تهيّئ زر الحث على الإجراء الأساسي في العارض (النص، والرابط، والموضع، واللون).

أخطاء شائعة: الحقول هي IsCTAButton، وCTAButtonText، وCTAButtonURL (بالإضافة إلى الموضع/اللون) — وليست Text/URL/Position.

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط زر الحث الأساسي

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsCTAButton`true \| false	مثل `false`
`CTAButtonText`	—
`CTAButtonColor`	—
`CTAButtonURL`URL	بادئات mailto: / tel: تُطبَّع تلقائيًا على جانب الخادم
`CTAButtonTextColor`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsCTAButtontrue / false

CTAButtonText

CTAButtonColor

CTAButtonURLURLبادئات mailto: / tel: تُطبَّع تلقائيًا على جانب الخادم

CTAButtonTextColor

ضبط زر الحث الثانوي

تهيّئ زر الحث على الإجراء الثانوي في العارض.

أخطاء شائعة: الزر الثانوي يستخدم الحقول المنتهية بـ 2 — IsCTAButton2، وCTAButtonText2، وCTAButtonURL2.

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط زر الحث الثانوي

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsCTAButton2`true \| false	مثل `false`
`CTAButtonText2`	—
`CTAButtonColor2`	—
`CTAButtonTextColor2`	—
`CTAButtonURL2`URL	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsCTAButton2true / false

CTAButtonText2

CTAButtonColor2

CTAButtonTextColor2

CTAButtonURL2URL

ضبط قواعد معاينة زر الحث

تهيّئ متى يُعرَض زر الحث على الإجراء للقرّاء — مثل بعد N صفحة أو N ثانية (قواعد بوابة المعاينة).

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط قواعد معاينة زر الحث

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsCTAHiddenInPreviewtrue | false مثل false

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsCTAHiddenInPreviewtrue / false

الأقسام — التحكم بالوصول

ضبط الوصول بكلمة مرور

تفعّل أو تعطّل الحماية بكلمة مرور للكتيب وتضبط كلمة مرور الوصول.

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الوصول بكلمة مرور

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsPasswordProtected`true \| false	مثل `false`
`Password`	—
`PwdTitle`	—
`PwdPlaceholder`	—
`PwdButton`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsPasswordProtectedtrue / false

Password

PwdTitle

PwdPlaceholder

PwdButton

ضبط الفهرسة

تتحكم في فهرسة محركات البحث للكتيب المستضاف. IsNoIndex=true يضيف noindex لمحركات البحث حتى لا تُفهرَس الصفحة.

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الفهرسة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsNoIndextrue | false مثل false

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsNoIndextrue / false

ضبط قائمة البريد المسموح بها

تقيّد وصول العارض بقائمة من عناوين البريد الإلكتروني المسموح بها (مشاهدة مقيّدة).

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط قائمة البريد المسموح بها

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

EmailsAllowed قائمة محدّدة بعناوين البريد المسموح بها

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

EmailsAllowedقائمة محدّدة بعناوين البريد المسموح بها

الأقسام — التقاط العملاء المحتملين

ضبط التقاط العملاء المحتملين (الأساس)

تفعّل وتهيّئ نموذج التقاط العملاء المحتملين الأساسي (البوابة التي تجمع تفاصيل الزائر قبل القراءة).

أخطاء شائعة: علم التفعيل هو IsLeadCapture، وليس IsEnabled.

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقاط العملاء المحتملين (الأساس)

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsLeadCapture`true \| false	مثل `false`
`LeadCaptureTitle`	—
`IsLeadAllowSkip`true \| false	مثل `false`
`LeadSkipText`	—
`LeadFormAfterPages`number	مثل `0`
`LeadAfterPages`number	مثل `0`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsLeadCapturetrue / false

LeadCaptureTitle

IsLeadAllowSkiptrue / false

LeadSkipText

LeadFormAfterPagesnumber

LeadAfterPagesnumber

ضبط حقول العميل المحتمل

تبدّل كل حقل قياسي لالتقاط العملاء المحتملين (الاسم، والبريد الإلكتروني، والهاتف، والشركة، إلخ) وما إذا كان إلزاميًا.

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقاط العملاء المحتملين (الأساس)(فعّل التقاط العملاء المحتملين)→ضبط حقول العميل المحتمل

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsLeadEmail`true \| false	مثل `true`
`IsLeadEmailMandatory`true \| false	مثل `true`
`IsLeadName`true \| false	مثل `true`
`IsLeadNameMandatory`true \| false	مثل `false`
`IsLeadPhone`true \| false	مثل `false`
`IsLeadPhoneMandatory`true \| false	مثل `false`
`IsLeadCompany`true \| false	مثل `false`
`IsLeadCompanyMandatory`true \| false	مثل `false`
`IsLeadDate`true \| false	مثل `false`
`IsLeadDateMandatory`true \| false	مثل `false`
`LeadPhoneCountry`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsLeadEmailtrue / false

IsLeadEmailMandatorytrue / false

IsLeadNametrue / false

IsLeadNameMandatorytrue / false

IsLeadPhonetrue / false

IsLeadPhoneMandatorytrue / false

IsLeadCompanytrue / false

IsLeadCompanyMandatorytrue / false

IsLeadDatetrue / false

IsLeadDateMandatorytrue / false

LeadPhoneCountry

ضبط الحقول المخصصة للعميل المحتمل

تعرّف حقولًا مخصصة إضافية في نموذج التقاط العملاء المحتملين، إضافةً إلى الاسم/البريد الإلكتروني/الهاتف القياسية.

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقاط العملاء المحتملين (الأساس)(فعّل التقاط العملاء المحتملين)→ضبط الحقول المخصصة للعميل المحتمل

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsLeadCustom1`true \| false	مثل `false`
`IsLeadCustom1Mandatory`true \| false	مثل `false`
`Custom1Label`	—
`IsLeadCustom2`true \| false	مثل `false`
`IsLeadCustom2Mandatory`true \| false	مثل `false`
`Custom2Label`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsLeadCustom1true / false

IsLeadCustom1Mandatorytrue / false

Custom1Label

IsLeadCustom2true / false

IsLeadCustom2Mandatorytrue / false

Custom2Label

ضبط تسميات العميل المحتمل

تضبط التسميات الظاهرة والنص النائب لحقول نموذج التقاط العملاء المحتملين.

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقاط العملاء المحتملين (الأساس)(فعّل التقاط العملاء المحتملين)→ضبط تسميات العميل المحتمل

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`LeadEmail`email	—
`LeadName`	—
`LeadPhone`phone	—
`LeadCompany`	—
`LeadDate`	—
`LeadButton`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

LeadEmailemail

LeadName

LeadPhonephone

LeadCompany

LeadDate

LeadButton

ضبط خصوصية العميل المحتمل

تهيّئ نص وخيارات الخصوصية/الموافقة في التقاط العملاء المحتملين (مثل خانة موافقة GDPR).

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقاط العملاء المحتملين (الأساس)(فعّل التقاط العملاء المحتملين)→ضبط خصوصية العميل المحتمل

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsLeadPrivacyPolicy`true \| false	مثل `false`
`PrivacyPolicyURL`URL	—
`PrivacyPolicyText`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsLeadPrivacyPolicytrue / false

PrivacyPolicyURLURL

PrivacyPolicyText

ضبط التحقق من العميل المحتمل

تفعّل أو تعطّل التحقق من بريد العميل المحتمل، مطالِبةً الزوّار بتأكيد بريدهم الإلكتروني قبل الوصول.

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقاط العملاء المحتملين (الأساس)(فعّل التقاط العملاء المحتملين)→ضبط التحقق من العميل المحتمل

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsVerifyEmail`true \| false	مثل `false`
`IsVerifyMobile`true \| false	مثل `false`
`TwillioAPIKey`	مفتاح Twilio API الخاص بك (يحتفظ اسم الحقل بالتهجئة الأصلية 'Twillio').
`EmailVerifyTitleText`	—
`EmailVerifyButtonText`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsVerifyEmailtrue / false

IsVerifyMobiletrue / false

TwillioAPIKeyمفتاح Twilio API الخاص بك (يحتفظ اسم الحقل بالتهجئة الأصلية 'Twillio').

EmailVerifyTitleText

EmailVerifyButtonText

ضبط webhook العميل المحتمل

تضبط رابط webhook يستقبل كل عميل محتمل جديد (يُحفَظ بصفته webhook العميل المحتمل الجديد). استخدم test-webhook للتحقق من تشغيله.

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقاط العملاء المحتملين (الأساس)(فعّل التقاط العملاء المحتملين)→ضبط webhook العميل المحتمل

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

WebhookURL_NewLeadURL رابط نقطة النهاية لديك — يستقبل حمولة JSON لكل عميل محتمل جديد.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

WebhookURL_NewLeadURLرابط نقطة النهاية لديك — يستقبل حمولة JSON لكل عميل محتمل جديد.

اختبار webhook

يطلق حمولة اختبار إلى webhook العميل المحتمل المهيّأ للكتيب حتى تتحقق من صيغة التسليم دون عميل محتمل حقيقي. يُرجع ERROR بالرسالة 'No lead webhook is configured for this flipbook.' إذا لم يُضبط أي منها. يطابق شكل الحمولة عميلًا محتملًا حقيقيًا (المفاتيح: pdf_id، وpdf_name، وlead_name، وlead_email، وlead_phone، وlead_company، وlead_date، وlead_custom_1، وlead_custom_2) لكنها تحمل قيمًا وهمية (pdf_id:"-1"، pdf_name:"Test PDF"، ...). لا يُخزَّن أي عميل محتمل حقيقي ولا يُرسَل أي بريد إشعار.

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط webhook العميل المحتمل(يجب تهيئة webhook أولًا)→اختبار webhook

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة HTTP وحدها.

ذات صلةضبط webhook العميل المحتمل

POST/api/test-webhook/{flipbookId}

curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

ضبط Google Sheets للعملاء المحتملين

تربط التقاط العملاء المحتملين بورقة Google Sheet — تُضاف العملاء المحتملون الجدد إلى الورقة التي تحدّدها (sheet ID + الاسم).

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط التقاط العملاء المحتملين (الأساس)(فعّل التقاط العملاء المحتملين)→ضبط Google Sheets للعملاء المحتملين

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`GoogleSheetURL`URL	—
`GoogleSheetIDKey`	—
`GoogleSheetName`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

GoogleSheetURLURL

GoogleSheetIDKey

GoogleSheetName

الأقسام — الإشعارات وقوالب البريد

ضبط الإشعارات

تهيّئ إشعارات البريد الإلكتروني التي تتلقاها لهذا الكتيب (عميل محتمل جديد، ومشاهدة جديدة، وبيع جديد).

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط الإشعارات

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`NotificationsEmail`email	—
`IsSendEmailOnView`true \| false	مثل `false`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

NotificationsEmailemail

IsSendEmailOnViewtrue / false

ضبط قالب البريد — عميل محتمل جديد

تضبط البريد المُرسَل عند حدث عميل محتمل جديد. أرسِل قيمًا فارغة لاستعادة قالب NEW_LEAD الافتراضي.

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط قالب البريد — عميل محتمل جديد

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`EmailLeadSubject`	—
`EmailLeadBody`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

EmailLeadSubject

EmailLeadBody

ضبط قالب البريد — مشاهدة جديدة

تضبط قالب البريد المُرسَل عند إشعار مشاهدة جديدة. أرسِل فارغًا لاستعادة قالب NEW_VIEW الافتراضي.

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط قالب البريد — مشاهدة جديدة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`EmailViewSubject`	—
`EmailViewBody`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

EmailViewSubject

EmailViewBody

ضبط قالب البريد — بيع جديد

تضبط قالب البريد المُرسَل عند إشعار بيع جديد. أرسِل فارغًا لاستعادة قالب NEW_SALE الافتراضي.

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط قالب البريد — بيع جديد

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`EmailSaleSubject`	—
`EmailSaleBody`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

EmailSaleSubject

EmailSaleBody

الأقسام — المبيعات

ضبط إعدادات البيع

تهيّئ بيع الكتيب (السعر، والعملة، والخيارات). تفعيل وضع البيع يفعّل تلقائيًا التحقق من البريد الإلكتروني ويجعل بريد العميل المحتمل إلزاميًا.

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→قائمة العملات(اختر SaleCurr)→ضبط إعدادات البيع

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsForSale`true \| false	مثل `false`
`SaleCurr`	من /api/list-currencies
`SaleAmount`number	مثل `0`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsForSaletrue / false

SaleCurrمن /api/list-currencies

SaleAmountnumber

ضبط نص صفحة البيع

تضبط النص التسويقي المعروض على صفحة البيع / الدفع للكتيب.

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط إعدادات البيع(فعّل البيع)→ضبط نص صفحة البيع

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`SalePageTitle`	—
`SaleAccessPageTitle`	—
`SalePurchaseButtonText`	—
`SaleButtonText`	—
`SaleAccessButtonText`	—
`SaleButtonColor`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

SalePageTitle

SaleAccessPageTitle

SalePurchaseButtonText

SaleButtonText

SaleAccessButtonText

SaleButtonColor

ضبط بوابة البيع

تختار وتهيّئ بوابة الدفع المستخدمة عند بيع هذا الكتيب.

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط إعدادات البيع(فعّل البيع)→ضبط بوابة البيع

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`SaleGatewayName`	—
`SaleGatewayKey`	—
`SaleGatewaySecret`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

SaleGatewayName

SaleGatewayKey

SaleGatewaySecret

الأقسام — الموافقة

ضبط زر الموافقة

تضيف زر طلب موافقة إلى العارض. تفعيله يطلق سير عمل طلب الموافقة.

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(DocType=document — عناصر المستندات فقط)→ضبط زر الموافقة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsApprovalButton`true \| false	مثل `false`
`ApprovalButtonText`	—
`ApprovalButtonColor`	—
`ApprovalButtonTextColor`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsApprovalButtontrue / false

ApprovalButtonText

ApprovalButtonColor

ApprovalButtonTextColor

ضبط قوالب بريد الموافقة

تضبط قوالب البريد المستخدمة في سير عمل الموافقة. القيم الفارغة تستدعي الافتراضيات.

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(DocType=document — عناصر المستندات فقط)→ضبط قوالب بريد الموافقة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`EmailApproveRequestSubject`	—
`EmailApproveRequestBody`	—
`EmailApproveRemindSubject`	—
`EmailApproveRemindBody`	—
`EmailApproveSubmitSubject`	—
`EmailApproveSubmitBody`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

EmailApproveRequestSubject

EmailApproveRequestBody

EmailApproveRemindSubject

EmailApproveRemindBody

EmailApproveSubmitSubject

EmailApproveSubmitBody

الأقسام — المشاركة

ضبط المفتاح الرئيسي للمشاركة

مفتاح تشغيل/إيقاف رئيسي لأزرار المشاركة في العارض.

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط المفتاح الرئيسي للمشاركة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsShareButtonstrue | false مثل false

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsShareButtonstrue / false

ضبط قنوات المشاركة

تبدّل كل قناة مشاركة اجتماعية (Facebook، وX، وLinkedIn، وWhatsApp، والبريد الإلكتروني، إلخ) كلًّا على حدة في قائمة المشاركة بالعارض.

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط قنوات المشاركة

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsShareFacebook`true \| false	مثل `true`
`IsShareTwitter`true \| false	مثل `true`
`IsShareWhatsApp`true \| false	مثل `true`
`IsShareTelegram`true \| false	مثل `false`
`IsShareLinkedIn`true \| false	مثل `true`
`IsSharePinterest`true \| false	مثل `false`
`IsShareReddit`true \| false	مثل `false`
`IsShareTumblr`true \| false	مثل `false`
`IsShareMessenger`true \| false	مثل `false`
`IsShareEmail`true \| false	مثل `true`
`IsShareLine`true \| false	مثل `false`
`IsShareWeChat`true \| false	مثل `false`
`IsShareInstagram`true \| false	مثل `false`
`IsShareFlipboard`true \| false	مثل `false`
`IsShareGeneral`true \| false	مثل `true`

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsShareFacebooktrue / false

IsShareTwittertrue / false

IsShareWhatsApptrue / false

IsShareTelegramtrue / false

IsShareLinkedIntrue / false

IsSharePinteresttrue / false

IsShareReddittrue / false

IsShareTumblrtrue / false

IsShareMessengertrue / false

IsShareEmailtrue / false

IsShareLinetrue / false

IsShareWeChattrue / false

IsShareInstagramtrue / false

IsShareFlipboardtrue / false

IsShareGeneraltrue / false

الأقسام — التتبّع والذكاء الاصطناعي

ضبط تتبّع التحليلات

تضيف معرّفات التتبّع التحليلية الخاصة بك (مثل Google Analytics، وGTM، وFacebook Pixel) إلى الكتيب المستضاف.

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط تتبّع التحليلات

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`FacebookAnalyticsCode`	—
`GoogleAnalyticsCode`	—
`GoogleTagManager`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

FacebookAnalyticsCode

GoogleAnalyticsCode

GoogleTagManager

ضبط مزوّد الذكاء الاصطناعي

تهيّئ مزوّد الذكاء الاصطناعي المستخدم لمزايا الذكاء الاصطناعي — اسم المزوّد ومفتاح الـ API الخاص به.

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط مزوّد الذكاء الاصطناعي

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`AIProvider`	—
`AIKey`	—

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

AIProvider

AIKey

ضبط المساعد الافتراضي

تهيّئ الإعدادات الأساسية للمساعد الافتراضي داخل العارض (الدردشة/المساعدة).

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط المساعد الافتراضي

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`IsVA`true \| false	مثل `false`
`VAButtonText`	—
`VAButtonColor`	—
`VAButtonTextColor`	—
`VAText`	موجّه/تعليمات المساعد
`VAEmbeddings`	كتلة التضمينات (نص)

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

IsVAtrue / false

VAButtonText

VAButtonColor

VAButtonTextColor

VATextموجّه/تعليمات المساعد

VAEmbeddingsكتلة التضمينات (نص)

ضبط نص حالة المساعد الافتراضي

تضبط نص الحالة/الترحيب الذي يعرضه المساعد الافتراضي داخل العارض.

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}

المتطلبات المسبقةمن أنا(مفتاح API صالح)→إنشاء من ملف(احصل على flipbookId)→ضبط نص حالة المساعد الافتراضي

معاملات المسار

flipbookIdnumber المعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

`VAButtonStatus1`	تسمية حالة الاستماع
`VAButtonStatus2`	تسمية حالة التسجيل
`VAButtonStatus3`	تسمية حالة المعالجة
`VAButtonStatus4`	تسمية حالة التحدّث

استجابات الأخطاء

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

المفتاح المفقود/غير الصالح يُرفَض بـ HTTP 401 (صفحة HTML، بلا JSON). وكل خطأ آخر يُرجِع HTTP 200 مع { "Result": "ERROR", "Message": … } — لذا تفرّع دائمًا على Result، لا على حالة 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>'

مثال على الاستجابة200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

ألصِق مفتاح الـ API في ”مفتاح الـ API الخاص بك“ في الأعلى — ثم املأ الحقول أدناه وأرسِل.

معاملات المسار — مطلوبة لتحديد العنصر

flipbookIdrequirednumberالمعرّف الرقمي للكتيب/المستند — يُرجَع من create-by-file / create-by-url (باسم ID) أو من list.

معاملات الجسم

VAButtonStatus1تسمية حالة الاستماع

VAButtonStatus2تسمية حالة التسجيل

VAButtonStatus3تسمية حالة المعالجة

VAButtonStatus4تسمية حالة التحدّث

مرجع FlipLink API

مقدمة

المصادقة

صيغة الاستجابة وأنواع النتائج

التصفّح

حدود المعدّل

حدود الباقة والحصص

الأخطاء

الملف الشخصي

من أنا

استجابات الأخطاء

جلب الملف الشخصي

استجابات الأخطاء

تحديث الملف الشخصي (جزئي)

معاملات الجسم

استجابات الأخطاء

الاشتراك والمدفوعات

جلب تفاصيل الاشتراك

استجابات الأخطاء

قائمة المدفوعات

استجابات الأخطاء

العناصر — إنشاء

إنشاء من ملف

الجسم (multipart/form-data)

استجابات الأخطاء

إنشاء من رابط

معاملات الجسم

استجابات الأخطاء

العناصر — قراءة

جلب عنصر واحد

معاملات المسار

استجابات الأخطاء

البحث عبر الرابط

معاملات الاستعلام

استجابات الأخطاء

قائمة

معاملات الاستعلام

استجابات الأخطاء

جلب رابط PDF

معاملات المسار

استجابات الأخطاء

جلب رابط المشاركة

معاملات المسار

استجابات الأخطاء

العناصر — تعديل

تكرار

معاملات المسار

معاملات الجسم

استجابات الأخطاء

استبدال PDF (ملف)

معاملات المسار

الجسم (multipart/form-data)

استجابات الأخطاء

استبدال PDF (رابط)

معاملات المسار

معاملات الجسم

استجابات الأخطاء

الحفظ كقالب (تبديل)

معاملات المسار

معاملات الجسم

استجابات الأخطاء

الإسناد إلى مجلد

معاملات المسار

معاملات الجسم

استجابات الأخطاء

ضبط الصفحة الأمامية/الخلفية (ملف)

معاملات المسار

الجسم (multipart/form-data)

استجابات الأخطاء

ضبط الصفحة الأمامية/الخلفية (رابط)

معاملات المسار

معاملات الجسم

استجابات الأخطاء

إزالة الصفحة الأمامية/الخلفية

معاملات المسار

استجابات الأخطاء

ضبط الانتهاء / إزالة الانتهاء

معاملات المسار

معاملات الجسم

استجابات الأخطاء