صفحات الغلاف، وانتهاء صلاحية الرابط، والتثبيت

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

تتيح لك نقاط النهاية الخمس هذه إدارة صفحات غلاف الكتيّب، وانتهاء صلاحية رابطه، وما إذا كان مثبَّتًا — دون الحاجة إلى لوحة التحكم:

• أرفِق صفحة غلاف أمامية و/أو خلفية من ملف PDF مرفوع.
• أرفِق صفحة غلاف أمامية و/أو خلفية من رابط PDF بعيد.
• امسح الغلاف الأمامي/الخلفي، لتعيد الكتيّب إلى ملف PDF الأساسي بلا غلاف.
• حدّد أو أزِل انتهاء صلاحية تلقائيًا على الكتيّب.
• ثبّت أو ألغِ تثبيت الكتيّب ليُرتَّب في أعلى لوحة تحكّمك.

قبل أن تبدأ

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

حدّد صفحات الغلاف الأمامية/الخلفية من ملف

أرفِق صفحة الغلاف و/أو الصفحة الخلفية من ملفات PDF مرفوعة. أيٌّ من Front/Back اختياري — لكن واحدًا منهما على الأقل مطلوب. تُعاد الصفحات ودمجها مع ملف PDF الرئيسي الحالي.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

الاستجابة:

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

حدّد صفحات الغلاف الأمامية/الخلفية من رابط

هذه هي صيغة الرابط لما سبق — تُرفِق صفحة الغلاف/الصفحة الخلفية من رابط PDF بعيد بدلًا من ملف مرفوع. يُرسَل حقلا Front وBack بصيغة form-urlencoded.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

الاستجابة:

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

امسح صفحات الغلاف الأمامية/الخلفية

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

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

الاستجابة:

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

حدّد أو أزِل الصلاحية

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

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

الاستجابة:

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

لإزالة الصلاحية، أرسِل Days=-1:

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=-1' \
  --data-urlencode 'Hours=0'

ثبّت أو ألغِ التثبيت

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

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

الاستجابة:

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

الأخطاء المحتملة

• مفتاح API مفقود أو غير صالح ← HTTP 401. تُعيد هذه الحالة صفحة HTML عادية لعدم التصريح — دون أي جسم JSON. تحقّق من وجود ترويسة X-Api-Key وصحّتها.
• flipbookId مجهول (أو غير مملوك لمفتاحك) ← HTTP 200 مع "Message": "Item not found".
• تحديد صفحة الغلاف الأمامية/الخلفية (بالملف) — PDF غير صالح ← HTTP 200 مع "Message": "File is not a valid PDF." عندما لا يكون الملف المرفوع PDF قابلًا للقراءة.
• تحديد صفحة الغلاف الأمامية/الخلفية (بالملف) — الملف كبير جدًا ← HTTP 413 مع "Message": "File exceeds the maximum allowed upload size." عندما يتجاوز الرفع الحد الأقصى لحجم الملف في الباقة.
• تحديد صفحة الغلاف الأمامية/الخلفية (بالرابط) وتحديد الصلاحية — حقل مجهول ← HTTP 200 مع "Message": "Unknown field(s) '…'. Expected: …" عندما يكون حقل الجسم مكتوبًا خطأً أو غير معروف.