إعداد نموذج التقاط العملاء المحتملين

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

نموذج التقاط العملاء المحتملين هو بوابة تجمع تفاصيل المشاهدين قبل أن يقرؤوا الكتيّب. وتتيح لك أربع نقاط نهاية بناء ذلك النموذج وضبطه بالكامل عبر الـ API:

• فعّل واضبط البوابة الأساسية — شغّل التقاط العملاء المحتملين، وحدّد عنوانها، واسمح بالتخطّي (أو امنعه)، وتحكّم في عدد الصفحات التي يظهر بعدها النموذج.
• بدّل الحقول القياسية — الاسم، والبريد الإلكتروني، والهاتف، والشركة، والتاريخ — وميّز كلًّا منها إلزاميًا أو اختياريًا.
• عرّف حقولًا مخصّصة إضافية إلى جانب المجموعة القياسية، بنصوصها الخاصة.
• حدّد نصوص العرض والعنصر النائب المعروضة لكل حقل.

تستهدف كل نقطة نهاية كتيّبًا واحدًا عبر {flipbookId} الخاص به وتطبّق التغييرات باستدعاء PUT واحد.

قبل أن تبدأ

• مفتاح 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.

فعّل واضبط البوابة الأساسية

يفعّل PUT /api/set-lead-capture/{flipbookId} نموذج التقاط العملاء المحتملين الأساسي ويضبطه. راية التفعيل هي IsLeadCapture (والخطأ الشائع هو البحث عن IsEnabled — فذلك الحقل غير موجود هنا).

curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=true' \
  --data-urlencode 'LeadCaptureTitle=Please share your details to continue' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=Skip' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'

الاستجابة:

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

يحمل الجسم راية التفعيل (IsLeadCapture)، وعنوان النموذج (LeadCaptureTitle)، وبدّالة التخطّي (IsLeadAllowSkip)، ونصّها LeadSkipText — النص المعروض على زر التخطّي (الافتراضي Skip). كما يحمل حقلَي عدد صفحات مستقلّين، LeadFormAfterPages وLeadAfterPages، يُخزَّن كلٌّ منهما على حِدة. ويتحكّم عدّادا الصفحات في توقيت ظهور النموذج على جانب المشاهد؛ فاضبط كليهما بعناية لتحصل على السلوك الذي تريده.

بدّل الحقول القياسية

يبدّل PUT /api/set-lead-fields/{flipbookId} كل حقل قياسي في التقاط العملاء المحتملين (الاسم، والبريد الإلكتروني، والهاتف، والشركة، والتاريخ) وما إذا كان إلزاميًا. لكل حقل راية Is… لإظهاره وراية Is…Mandatory لجعله مطلوبًا.

كما يحمل الجسم LeadPhoneCountry، الذي يحدّد الدولة / رمز الاتصال الافتراضي لحقل الهاتف. ويقبل قيمة مثل US أو +1 ويُخزَّن كما هو؛ وقيمته الافتراضية فارغة.

curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/96216' \
  -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='

الاستجابة:

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

عرّف حقولًا مخصّصة

يعرّف PUT /api/set-lead-custom-fields/{flipbookId} حقولًا مخصّصة إضافية على نموذج التقاط العملاء المحتملين، إلى جانب الاسم/البريد الإلكتروني/الهاتف القياسي. لكل حقل مخصّص راية إظهار، وراية إلزام، ونصّ.

curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label='

الاستجابة:

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

حدّد نصوص الحقول

يحدّد PUT /api/set-lead-labels/{flipbookId} نصوص العرض والعنصر النائب لحقول نموذج التقاط العملاء المحتملين، بما في ذلك زر الإرسال.

curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=' \
  --data-urlencode 'LeadName=' \
  --data-urlencode 'LeadPhone=' \
  --data-urlencode 'LeadCompany=' \
  --data-urlencode 'LeadDate=' \
  --data-urlencode 'LeadButton='

الاستجابة:

{
  "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: …". طابِق التهجئة والحالة الدقيقتين لكل اسم حقل من الأمثلة أعلاه.

ملاحظات

• لتشغيل التقاط العملاء المحتملين، فعّله عبر set-lead-capture (IsLeadCapture=true) قبل الاعتماد على نقاط الحقول، والحقول المخصّصة، والنصوص — فتلك تضبط النموذج الذي تعرضه البوابة الأساسية.