واجهة وقت تشغيل الأداة
تحكّم في الأداة من JavaScript عبر كائن window.syncanix.
بمجرّد تحميل الأداة، تثبّت كائن window.syncanix الذي يمكنك استدعاؤه من شيفرتك الخاصة.
ما الذي يمكنك فعله
- open() — فتح لوحة الدردشة برمجيًا.
- setPosition(position) — نقل المشغّل إلى زاوية أخرى.
- enable() / disable() — تشغيل الدردشة أو إيقافها أثناء التشغيل دون إزالتها (للأعطال أو الدفع أو ساعات الدعم).
- unmount() — إزالة الأداة من الصفحة.
- registerComponent() / unregisterComponent() / getComponentCatalog() — سجّل مكوّنات React الخاصة بك كي يعرضها المساعد، مُتحقَّقًا منها بمخطّط.
- registerAction() / unregisterAction() / getActionCatalog() — تتيح للمساعد استدعاء دوالك الخاصة، مع التحقق من المخطط وبوابة تأكيد اختياريين.
- setContext() / clearContext() — تغذية الحالة الحيّة للتطبيق (المستخدم، الصفحة، السلّة) في الدور التالي. JSON محدود فقط — لا أسرار أبدًا.
- setTokenProvider(fn) — توفير رمز المستخدم النهائي لكل دور (له أولوية على سمة data).
- setStepUpProvider(fn) — توفير تدفّق إعادة المصادقة المعزَّزة.
- setHeadersProvider(fn) — يضيف ترويسات طلب (مثل Authorization أو رمز CSRF) إلى كل استدعاء أداة؛ وله الأولوية على سمة البيانات.
- setTheme(key) — يبدّل السمة الحية بالاسم دون إعادة تركيب الدردشة (لمبدّل فاتح/داكن في الموقع المضيف).
مثال
// Open the chat programmatically
window.syncanix.open();
// Feed live host-app context into the next turn (bounded JSON, no secrets)
window.syncanix.setContext({ page: 'checkout', cartItems: 3 });
// Provide the signed-in user's token per turn (recommended for SSR apps)
window.syncanix.setTokenProvider(async () => await getAccessToken());ما الذي يمكن للمساعد عرضه — وما ا لذي لا يمكنه رؤيته
سطح العرض صريح بالتصميم: العناصر الأولية المدمجة، والمكوّنات التي تسجّلها عبر registerComponent، والتضمينات من الأصول التي أدرجها مسؤولك في قائمة السماح. لا يمكن للمساعد التحكم إلا فيما سلّمته له عمدًا.
لا تفحص الأداة DOM صفحتك ولا تكتشفه تلقائيًا ولا تلتقطه إلى النموذج أبدًا. قراءة محتوى الصفحة المضيفة في سياق ذكاء اصطناعي هي سطح لتسريب البيانات والحقن؛ لذا يبقى التقاط DOM الحي بوساطة العميل: أنت من يقرر ما هو قابل للتضمين عبر تسجيله.
يُحمَّل مرة واحدة
تثبيت الكائن العام عملية مُتكافئة — فإن أُدرِج السكربت مرتين، يُتجاهَل المكرّر مع تحذير، فلا تنتهي أبدًا بأداتين.