وضع علامتك التجارية على كتيّب (الشعار، والأيقونة المفضّلة، والمظهر، والخلفية)

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

تتيح لك خمس نقاط نهاية للكتابة وضع علامتك التجارية على العارض المُستضاف للكتيّب دون الحاجة إلى لوحة التحكم. تستهدف كلٌّ منها كتيّبًا واحدًا (عبر {flipbookId} الخاص به) وتغيّر جانبًا واحدًا من مظهره:

• حدّد الشعار المعروض في منطقة الترويسة/العلامة التجارية في العارض.
• حدّد الأيقونة المفضّلة (أيقونة تبويب المتصفّح) لصفحة العارض المُستضافة.
• طبّق مظهرًا/سِمة على العارض.
• حدّد صورة الخلفية للعارض.
• حدّد نص التحميل المخصّص المعروض على شاشة تحميل العارض.

قبل أن تبدأ

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

حدّد الشعار

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

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

تقبل نقطة النهاية هذه ثلاثة حقول في الجسم:

• LogoIMG — صورة الشعار نفسها (رابطها/مسارها). وهي الصورة المعروضة في منطقة الترويسة/العلامة التجارية في العارض.
• LogoURL — رابط النقر الذي يشير إليه الشعار؛ فالنقر على الشعار يفتح هذا الرابط. وقيمته الافتراضية https://fliplink.me.
• IsShowLogoMobile — قيمة boolean (true / false، والافتراضي false) تبدّل ما إذا كان الشعار معروضًا على الجوّال.

الاستجابة:

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

حدّد الأيقونة المفضّلة

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

curl -X PUT 'https://go.fliplink.me/api/set-favicon/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG='

الاستجابة:

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

طبّق مظهرًا

يطبّق مظهر/سِمة العارض على الكتيّب؛ ويحوّل الخادم اسم المظهر إلى مُعرّفه. الحقل هو SkinName (السلسلة من list-skins)، لا مُعرّف رقمي.

curl -X PUT 'https://go.fliplink.me/api/set-skin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName='

الاستجابة:

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

حدّد صورة الخلفية

يحدّد صورة خلفية العارض من رابط تقدّمه (لا يوجد معرض مدمج). يأخذ BackgroundIMG رابط صورة، أو رابط عنصر نائب مثل https://plchldr.co/i/100x100?text=&bg=HEX. وأي قيمة لون هي سلسلة hex بالشكل #RRGGBB وتُخزَّن كما هي.

curl -X PUT 'https://go.fliplink.me/api/set-background-image/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundIMG='

الاستجابة:

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

حدّد نص التحميل

يحدّد النص المخصّص المعروض على شاشة تحميل العارض. الحقل هو CustomLoadingText، لا LoadingText.

curl -X PUT 'https://go.fliplink.me/api/set-loading-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText='

الاستجابة:

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

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

تنطبق هذه على النقاط الخمس جميعها:

• مفتاح API مفقود أو غير صالح ← HTTP 401. تُعيد هذه الحالة صفحة HTML عادية لعدم التصريح — دون أي جسم JSON. تحقّق من وجود ترويسة X-Api-Key (أو Authorization: Bearer) وصحّتها.
• مُعرّف العنصر غير موجود أو غير مملوك لمفتاحك ← HTTP 200 مع Message: "Item not found".
• حقل مجهول أو مكتوب خطأً في الجسم ← HTTP 200 مع Message: "Unknown field(s) '…'. Expected: …".

ملاحظات

• في تحديد المظهر، أرسِل Name المظهر (من /api/list-skins) في SkinName — لا مُعرّفًا رقميًا.
• في تحديد نص التحميل، الحقل هو CustomLoadingText؛ وإرسال LoadingText سيُرفَض بوصفه حقلًا مجهولًا.
• في تحديد صورة الخلفية، لا يوجد معرض مدمج — فأنت تقدّم رابط الصورة بنفسك.