استرجاع العملاء المحتملين وحذفهم

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

تتيح لك نقاط النهاية الثلاث هذه قراءة مُدخلات التقاط العملاء المحتملين التي تجمعها كتيّباتك وتنظيفها:

• اسرد العملاء المحتملين عبر كل كتيّباتك أو عبر كتيّب محدّد، مع البحث والتصفّح والتصدير إلى CSV.
• احذف عميلًا محتملًا واحدًا عبر مُعرّفه.
• احذف العملاء المحتملين جماعيًا بالتصفية (الكتيّب، أو البريد الإلكتروني، أو نطاق التاريخ).

قبل أن تبدأ

• مفتاح API — يُرسَل إمّا في ترويسة X-Api-Key أو ضمن Authorization: Bearer YOUR_API_KEY.
• تذهب جميع الطلبات إلى الرابط الأساسي https://go.fliplink.me.
• يستخدم حذف عميل محتمل واحد مقطع المسار {leadId}، كما تمرّر Email العميل وFlipbookID بوصفهما معطيات استعلام. أما الحذف الجماعي فلا معطى مسار له — إذ يصفّي عبر معطيات الاستعلام.
• لا تستخدم نقاط النهاية هذه جسم طلب؛ فكل المدخلات معطيات سلسلة استعلام.

اسرد العملاء المحتملين

يسرد GET /api/list-leads مُدخلات التقاط العملاء المحتملين التي جمعتها كتيّباتك. ويُعيد Items[] إضافةً إلى مخطّط أعمدة ديناميكي Columns[] (لعرض جدول) وTotalRecordCount. ويدعم التصفّح والتصدير إلى CSV عبر IsDownload. مرّر ItemIDs (مُعرّفات كتيّبات مفصولة بفاصلة أو بشرطة عمودية؛ وفارغة = الكل) لتحديد نطاق النتائج. ومع IsDownload=false (أو فارغ) تحصل على جسم JSON المعروض أدناه؛ أما IsDownload=true فيُعيد تصدير ملف CSV بدلًا من ذلك.

curl -X GET 'https://go.fliplink.me/api/list-leads?ItemIDs=&SearchText=&PageNo=1&Offset=0&IsDownload=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

الاستجابة:

{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

احذف عميلًا محتملًا واحدًا

يحذف DELETE /api/delete-lead/{leadId} عميلًا محتملًا واحدًا مُلتقَطًا عبر مُعرّفه. مقطع المسار هو leadId (الـ LeadID من list-leads)؛ كما تمرّر Email العميل وFlipbookID الخاص به بوصفهما معطيات استعلام.

curl -X DELETE 'https://go.fliplink.me/api/delete-lead/0?Email=foo@example.com&FlipbookID={{flipbookId}}' \
  -H 'X-Api-Key: YOUR_API_KEY'

الاستجابة:

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

احذف العملاء المحتملين جماعيًا

يحذف DELETE /api/delete-leads العملاء المحتملين جماعيًا بالتصفية. ويُطلَب واحد على الأقل من FlipbookID / Email / DateFrom / DateTo — فالاستدعاء بلا تصفية يُرفَض (لا يوجد مسار «حذف الكل»). والعملية دائمًا محصورة بالمورّد وتُعيد { Result, Deleted (count) }. كما تنظّف الصفوف التابعة (سجلّ العرض / نقرات زر الحث / سجلّ التصدير إلى الجدول).

• FlipbookID — اختياري؛ احذف العملاء المحتملين على هذا الكتيّب فقط.
• Email — اختياري؛ بريد إلكتروني بمطابقة تامّة.
• DateFrom — اختياري؛ احذف العملاء المحتملين المُلتقَطين في هذا التاريخ أو بعده (يطابق Lead.CreatedOn). أي تاريخ قابل للتحليل، مثل 2026-01-01 أو 2026-01-01T00:00:00Z.
• DateTo — اختياري؛ احذف العملاء المحتملين المُلتقَطين في هذا التاريخ أو قبله.

curl -X DELETE 'https://go.fliplink.me/api/delete-leads?FlipbookID={{flipbookId}}&Email=&DateFrom=&DateTo=' \
  -H 'X-Api-Key: YOUR_API_KEY'

الاستجابة:

{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

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

• مفتاح API مفقود أو غير صالح ← HTTP 401. تُعيد هذه الحالة صفحة HTML عادية لعدم التصريح — دون أي جسم JSON. تحقّق من وجود ترويسة X-Api-Key (أو ترويسة Authorization: Bearer) وصحّتها.

ملاحظات

• يتطلّب الحذف الجماعي تصفيةً واحدة على الأقل (FlipbookID أو Email أو DateFrom أو DateTo)؛ والاستدعاء بلا تصفية يُرفَض — لا يوجد مسار «حذف الكل».
• الحذف الجماعي دائمًا محصور بالمورّد ويُزيل أيضًا الصفوف التابعة ذات الصلة (سجلّ العرض، ونقرات زر الحث، وسجلّ التصدير إلى الجدول).
• للحصول على مُعرّف عميل محتمل بغرض الحذف المفرد، استدعِ أولًا GET /api/list-leads.