حماية كتيّب بكلمة مرور

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

تضع حماية كلمة المرور بوابةً أمام الكتيّب: إذ يجب على المشاهدين إدخال كلمة المرور الصحيحة قبل أن يُحمَّل المحتوى. وباستدعاء API واحد يمكنك:

• تفعيل الحماية وتحديد كلمة مرور الوصول.
• إلغاء الحماية مجدّدًا.
• تخصيص شاشة كلمة المرور — العنوان، والعنصر النائب للإدخال، ونص الزر.

قبل أن تبدأ

ستحتاج إلى:

• مفتاح API — يُرسَل في ترويسة X-Api-Key مع كل طلب.
• الـ flipbookId — المُعرّف الرقمي المُعاد عند إنشاء كتيّب (بوصفه ID) أو من نقاط نهاية السرد.
• تذهب الطلبات إلى الرابط الأساسي https://go.fliplink.me.

يكون الجسم بصيغة form-urlencoded (لا JSON).

المعطيات

أرسِل هذه بوصفها حقول urlencoded على PUT /api/set-password-access/{flipbookId}:

فعّل حماية كلمة المرور

اضبط IsPasswordProtected=true وقدّم Password. أما حقول Pwd* الثلاثة فاختيارية — أدرِجها لتخصيص ما يراه المشاهد.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=true' \
  --data-urlencode 'Password=spring-2026' \
  --data-urlencode 'PwdTitle=Enter the access code' \
  --data-urlencode 'PwdPlaceholder=Access code' \
  --data-urlencode 'PwdButton=View document'

الاستجابة:

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

ألغِ حماية كلمة المرور

اضبط IsPasswordProtected=false. ويمكنك ترك الحقول الأخرى فارغة.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=' \
  --data-urlencode 'PwdTitle=' \
  --data-urlencode 'PwdPlaceholder=' \
  --data-urlencode 'PwdButton='

الاستجابة:

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

تخصيص شاشة كلمة المرور

تتيح لك حقول PwdTitle وPwdPlaceholder وPwdButton تفصيل البوابة بما يناسب جمهورك — مثل تسميتها «رمز وصول» لبوابة عميل، أو مطابقتها لنبرة علامتك التجارية. وهي اختيارية؛ فأغفِلها (أو أرسِلها فارغة) لاستخدام الافتراضيات.

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

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

ملاحظات

• شارك كلمة المرور عبر قناة منفصلة. أرسِل رابط الكتيّب وكلمة المرور عبر قناتين منفصلتين — فكلمة مرور مُدرَجة في البريد نفسه مع الرابط لا تقدّم حمايةً تُذكر.
• حماية كلمة المرور طبقة واحدة. فهي تتحكّم في الدخول، لا في هويّة المشاهد. ولتقييد الوصول على أشخاص مسمّين، اجمعها مع قائمة سماح بالبريد الإلكتروني؛ ولتحديد مدّة الوصول، اقرنها بانتهاء صلاحية الرابط.