سير عمل الموافقة

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

يتيح سير عمل الموافقة في FlipLink للمشاهدين طلب موافقة على مستند. وتضبطه نقطتا نهاية:

• أضِف زر طلب موافقة إلى العارض. وتفعيله يُطلِق سير عمل طلب الموافقة.
• حدّد قوالب البريد الإلكتروني التي يستخدمها سير عمل الموافقة — بريد الطلب، والتذكير، والإرسال.

ينطبق سير عمل الموافقة على عناصر المستندات فقط — العناصر المُنشأة بـ DocType=document. وهو غير متاح على الكتيّبات القياسية.

قبل أن تبدأ

ستحتاج إلى:

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

أضِف زر الموافقة

يضيف PUT /api/set-approval-button/{flipbookId} زر طلب موافقة إلى العارض. وتفعيله يُطلِق سير عمل طلب الموافقة.

curl -X PUT 'https://go.fliplink.me/api/set-approval-button/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=true' \
  --data-urlencode 'ApprovalButtonText=Request approval' \
  --data-urlencode 'ApprovalButtonColor=#0055FF' \
  --data-urlencode 'ApprovalButtonTextColor=#FFFFFF'

الحقول:

• IsApprovalButton — true لإظهار زر طلب الموافقة، وfalse لإخفائه.
• ApprovalButtonText — نص الزر.
• ApprovalButtonColor — لون خلفية الزر، بقيمة hex مع # البادئة (مثل #0055FF). والافتراضي #000000. وتُخزَّن القيمة كما هي؛ ولا يتحقّق الـ API منها.
• ApprovalButtonTextColor — لون نص الزر، بقيمة hex مع # البادئة (مثل #FFFFFF). والافتراضي #FFFFFF. وتُخزَّن القيمة كما هي؛ ولا يتحقّق الـ API منها.

الاستجابة:

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

حدّد قوالب بريد الموافقة

يحدّد PUT /api/set-approval-email-templates/{flipbookId} قوالب البريد الإلكتروني التي يستخدمها سير عمل الموافقة. لكل حقل نص افتراضي مدمج؛ وترك حقل فارغًا يُبقي ذلك الافتراضي.

يمكن أن يتضمّن نص القالب رموز دمج بالشكل ##TOKEN##، تُستبدَل عند إرسال البريد — فمثلًا ##DOCUMENT_TITLE## يُدرِج عنوان المستند.

curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=Approval needed: ##DOCUMENT_TITLE##' \
  --data-urlencode 'EmailApproveRequestBody=' \
  --data-urlencode 'EmailApproveRemindSubject=' \
  --data-urlencode 'EmailApproveRemindBody=' \
  --data-urlencode 'EmailApproveSubmitSubject=' \
  --data-urlencode 'EmailApproveSubmitBody='

الاستجابة:

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

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

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

ملاحظات

• في نقطة نهاية قوالب البريد، لكل حقل نص افتراضي مدمج؛ وإرسال قيمة فارغة لحقل يُبقي افتراضي ذلك القالب.
• يدعم نص قالب البريد رموز الدمج ##TOKEN## (مثل ##DOCUMENT_TITLE## لعنوان المستند)، وتُستبدَل عند الإرسال.
• ألوان الزر (ApprovalButtonColor وApprovalButtonTextColor) قيم hex مع # بادئة وتُخزَّن كما هي دون تحقّق؛ والافتراضيان هما #000000 و#FFFFFF.