تخطَّ إلى المحتوى الرئيسي
تصفّح التوثيق

إعداد الأداة

اضبط الأداة بسمات data-* على وسم السكربت.

تضبط الأداة بسمات data-* على وسم السكربت. وإليك المجموعة الكاملة.

<script
  type="module"
  src="https://cdn.syncanix.com/widget.js"
  data-key="pk_test_..."
  data-position="bottom-left"
  data-env="development"
  data-chat-size="large"
  data-locale="fr"
  data-config-load="eager"
></script>
مثال متكامل: مفتاح تطوير، مشغّل أسفل اليسار، لوحة كبيرة، واجهة بالفرنسية، وتحميل فوري للتهيئة.

السمات الأساسية

  • data-key — مفتاحك القابل للنشر (pk_test_… أو pk_live_…). مطلوب.
  • data-enabled — اضبطه على false لتحميل السكربت دون تركيب الويدجت (true افتراضيًا).
  • data-position — زاوية المشغّل: bottom-right (افتراضي)، أو bottom-left، أو top-right، أو top-left.
  • data-locale — يحدد لغة هذه الصفحة واتجاه نصها (مثل ar أو en-US). إذا تركته، فإن الأداة تتبع لغة صفحتك تلقائيا.
  • data-chat-size — small (افتراضي)، أو medium، أو large، أو fullscreen، أو embedded.
  • data-chat-mode — normal (افتراضي) أو split (تخطيط بلوحتين).
  • data-env — development أو production (وإلا يُستنتَج من بادئة المفتاح).
  • data-theme — سلسلة JSON بتجاوزات رموز السمة.

تتبع الأداة لغة صفحتك من تلقاء نفسها، دون الحاجة إلى أي خصيصة. فهي تقرأ ‎<html lang>‎ الخاص بك، وإذا كانت صفحتك تعرض نصا بخط مختلف عما تعلنه، فإنها تثق بما يظهر على الشاشة. استخدم مبدل اللغة الخاص بموقعك وستتبعه المحادثة في المتصفح، بلا إعادة تحميل ودون فقدان المحادثة. لا تستخدم data-locale إلا إذا أردت تجاوز ذلك في صفحة معينة.

أول رسالة يكتبها الزائر تحدد لغة المحادثة، وتبقى كذلك حتى لو غير لغة موقعك بعد ذلك: محادثة بدأت بالعبرية تستمر بالإجابة بالعبرية. أما تسميات الأداة وإشعار الذكاء الاصطناعي فتظل تتبع صفحتك، حتى يبقى الإشعار مقروءا باللغة التي يتصفح بها. ومن أراد تغيير اللغة، يكفي أن يطلب ذلك في المحادثة.

السمات المتقدّمة

  • data-origin — أصل واجهة برمجة تطبيقات Syncanix (الافتراضي هو واجهة الإنتاج).
  • data-theme-name — يختار تصميمًا مسمّى من مكتبتك؛ وتتبع auto إعداد الفاتح/الداكن في الموقع المضيف.
  • data-prompt-profile — يشغّل في هذه الصفحة ملف توجيه بعينه، بالاسم الذي نشرته به. لا يمكن تسمية سوى الملفات المنشورة؛ وأي قيمة أخرى ترجع إلى ملفك النشط.
  • data-mount-target — محدِّد CSS لمكان تركيب أداة مضمَّنة.
  • data-split-page — عنوان URL للصفحة التي تظهر بجانب الدردشة في وضع split.
  • data-config-load — lazy (جلب الإعدادات عند أول فتح، افتراضي) أو eager (عند التركيب).
  • data-executor — اسم دالة عامة تنفّذ إجراءات المتصفّح أو المضيف.
  • data-token-provider — اسم دالة عامة تُرجِع رمز المستخدم النهائي.
  • data-step-up-provider — اسم دالة عامة تطلق إعادة المصادقة المعزَّزة.
  • data-headers-provider — اسم دالة عامة تُرجِع ترويسات طلب إضافية.
  • data-client-witness — تفعيل المراقبة السلبية لحركة واجهة برمجة التطبيقات، شكليًا فقط (معطَّل افتراضيًا).
  • data-act-on-behalf-consent — اشتراط موافقة لمرة واحدة على «التصرّف نيابةً عنك» (معطَّل افتراضيًا).

الخطوات التالية