دليل الربط

اربط المساعد رفيق بموقعك عبر قناتين: مزامنة المحتوى، وتضمين الودجت بسطرٍ واحد.

نظرة عامة

ترسل عناصر موقعك إلى نموذج محتوًى موحّد، ويتكفّل رفيق بالتقطيع والفهرسة والبحث. ثم تضمّن الودجت بسطرٍ واحد فيجيب زوّارك ببطاقاتٍ وروابط موثوقة. الفهرسة تفاضلية: ما لم يتغيّر لا يُعاد فهرسته، فالمزامنة الدورية موفّرة.

المفاتيح

لكل حسابٍ زوج مفاتيح من لوحة التحكم، قسم «مفاتيح API»:

المفتاح السرّي يظهر مرةً واحدة عند إنشائه — احفظه فورًا؛ نخزّن بصمته فقط ولا يمكن استرجاعه.

مزامنة المحتوى — رفع / تحديث

POST /api/v1/content/items:upsert

المفتاح هو external_id (معرّفك للعنصر): أول إرسالٍ ينشئ، والتالي بالمعرّف نفسه يحدّث. حتى ١٠٠ عنصرٍ في الطلب.

# الترويسة: Authorization: Bearer sk_live_xxx
curl -X POST https://agentrafeeq.com/api/v1/content/items:upsert \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{
      "external_id": "product-1024",
      "type": "product",
      "title": "حذاء رياضي",
      "summary": "حذاء جريٍ خفيفٌ للمسافات الطويلة.",
      "url": "https://mystore.com/products/1024",
      "image_url": "https://mystore.com/img/1024.jpg",
      "price": 349.00,
      "currency": "SAR",
      "metadata": { "category": "أحذية" }
    }]
  }'
الحقلإلزاميالوصف
external_idنعممعرّفك الفريد (مفتاح التحديث).
typeنعمنوع المحتوى: product / article / tool …
titleنعمالعنوان (يظهر في البطاقة).
summary / bodyلاوصفٌ مختصر / نصٌّ كاملٌ يُفهرَس.
url / image_urlلاتُبنى منهما البطاقة — بروابط موثوقة.
price / currencyلاللمتاجر (العملة من ثلاثة أحرف).
metadataلاحقولٌ حرّةٌ حسب مجالك، تُفهرَس أيضًا.

حذف عنصر

DELETE /api/v1/content/items/{external_id}
curl -X DELETE https://agentrafeeq.com/api/v1/content/items/product-1024 \
  -H "Authorization: Bearer sk_live_xxx"

يُحذف العنصر ومقاطعه فورًا، ويظهر أثر ذلك في البحث مباشرةً.

إعادة فهرسة كاملة

POST /api/v1/content/reindex
curl -X POST https://agentrafeeq.com/api/v1/content/reindex \
  -H "Authorization: Bearer sk_live_xxx"

تضمين الودجت

أضِف هذا السطر قبل </body> في أي صفحة:

<script async
  src="https://agentrafeeq.com/widget.js"
  data-bot-key="pk_live_xxx"></script>

يعمل الودجت داخل حاويةٍ معزولة (لا تتأثّر بستايلات موقعك)، ويجلب إعداداته تلقائيًا، وحجمه نحو ١٠ كيلوبايت مضغوطًا وغير متزامنٍ فلا يبطئ صفحتك.

قائمة النطاقات المسموحة

من لوحة التحكم، اربط كل مفتاحٍ عامٍّ بنطاقات موقعك؛ حينها يرفض الخادم أي طلبٍ من متصفّحٍ على نطاقٍ غير مُدرَج، فلا يمكن استخدام مفتاحك على موقعٍ آخر. اترك القائمة فارغةً في التجارب فقط.

الحدود والحصص

البندالمجانيةالبدايةالاحترافية
رسائل / شهر٢٠٠٢٬٠٠٠١٠٬٠٠٠
رسائل / يوم٥٠٤٠٠١٬٥٠٠
عناصر المحتوى١٠٠١٬٠٠٠١٠٬٠٠٠

عند بلوغ الحد يردّ الخادم بالرمز 429 برسالةٍ لبقةٍ للزائر. ويحمي الودجت حدُّ معدّلٍ لكل مفتاحٍ ولكل عنوان IP.

مرجع الأخطاء

الرمزالمعنى
401مفتاحٌ مفقودٌ أو غير صالح.
403النطاق غير مسموحٍ لهذا المفتاح، أو الحساب غير نشط.
422بياناتٌ غير صالحة، أو تجاوزٌ لسقف عناصر المحتوى.
429تجاوزٌ لحدّ المعدّل أو لحصة الباقة.
500خطأ خادمٍ — رسالةٌ عامةٌ فقط دون تفاصيل داخلية.

جميع ردود الأخطاء بصيغة JSON على الشكل: { "message": "…", "code": "…" }.