الإشعارات وقوالب البريد الإلكتروني

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

تتيح لك نقاط النهاية هذه التحكّم في جانب البريد الإلكتروني لكتيّب واحد: أيّ الأحداث تُشعِرك، وماذا تقول تلك الرسائل. وبها يمكنك:

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

قبل أن تبدأ

• مفتاح 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-notifications/{flipbookId} لضبط إشعارات البريد الإلكتروني التي تستلمها عن هذا الكتيّب (عميل محتمل جديد، عرض جديد، بيع جديد).

حقول الجسم (form-urlencoded):

• NotificationsEmail — عنوان الوجهة الذي تُرسَل إليه رسائل الإشعارات. وفي كتيّب جديد يكون افتراضيًا بريد حسابك؛ ويمكنك تغييره إلى أي عنوان، أو إرساله فارغًا لمسحه.
• IsSendEmailOnView — قيمة boolean (true / false، والافتراضي false) تبدّل بريد «المُشاهَد». اضبطه true لاستلام بريد عندما يشاهد أحدهم الكتيّب. ويرسل المثال أدناه true.

curl -X PUT 'https://go.fliplink.me/api/set-notifications/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=you@example.com' \
  --data-urlencode 'IsSendEmailOnView=true'

الاستجابة:

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

حدّد قالب بريد العميل المحتمل الجديد

استخدم PUT /api/set-email-template-lead/{flipbookId} لتحديد البريد المُرسَل عند حدث عميل محتمل جديد. أرسِل قيمًا فارغة لاستعادة قالب NEW_LEAD الافتراضي.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=' \
  --data-urlencode 'EmailLeadBody='

الاستجابة:

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

حدّد قالب بريد العرض الجديد

استخدم PUT /api/set-email-template-view/{flipbookId} لتحديد قالب البريد المُرسَل عند إشعار عرض جديد. أرسِل فارغًا لاستعادة قالب NEW_VIEW الافتراضي.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=' \
  --data-urlencode 'EmailViewBody='

الاستجابة:

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

حدّد قالب بريد البيع الجديد

استخدم PUT /api/set-email-template-sale/{flipbookId} لتحديد قالب البريد المُرسَل عند إشعار بيع جديد. أرسِل فارغًا لاستعادة قالب NEW_SALE الافتراضي.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=' \
  --data-urlencode 'EmailSaleBody='

الاستجابة:

{
  "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: …".

ملاحظات

• تأتي قوالب بريد العميل المحتمل، والعرض، والبيع كلٌّ منها بنص افتراضي مدمج. وإرسال قيم فارغة يستعيد القالب الافتراضي لذلك الحدث (NEW_LEAD أو NEW_VIEW أو NEW_SALE على التوالي).
• تستخدم رموز الدمج اصطلاح ##TOKEN## — فمثلًا ##FLIPLINK## يُدرِج اسم الكتيّب في العنوان أو النص.