Keyda واجهة برمجة تطبيقات الأداة (Widget API)
للمطورين، أو أي شخص يريد فتح الدردشة من خلال زره الخاص.
التثبيت
<script src="https://keyda.in/business/widget.js"
data-key="kb_live_your_key_here" async></script>يحتاج وسم البرنامج النصي فقط إلى src و data-key. كل شيء آخر — الألوان، الموقع، التحية، اللغات — يأتي من لوحة التحكم الخاصة بك، لذا لن تضطر أبداً إلى إعادة نشر موقعك لتغييرها.
الأوضاع
عائم (افتراضي). زر تشغيل في الزاوية يفتح لوحة الدردشة.
مضمن. ضع حاوية فارغة في الصفحة وستقوم الدردشة بملئها بدلاً من ذلك:
<div data-keyda-bot style="height:520px"></div>يحتاج الحاوية إلى ارتفاع. في الوضع المضمن، تكون الدردشة مرئية دائماً، لذا لا يوجد شيء لفتحه أو إغلاقه.
JavaScript API
متاح على window.KeydaBot بمجرد تحميل البرنامج النصي:
| اتصال | ما الذي يفعله |
|---|---|
KeydaBot.open() | يفتح لوحة الدردشة |
KeydaBot.close() | إغلاق |
KeydaBot.toggle() | يفتح أو يغلق |
KeydaBot.expand() | يجعل اللوحة بطول النافذة وبعرض يصل إلى 760 بكسل |
KeydaBot.shrink() | العودة إلى البطاقة القياسية |
KeydaBot.isOpen | true عندما تكون الدردشة مرئية |
KeydaBot.isExpanded | true أثناء توسيع اللوحة |
KeydaBot.clientId | معرف العميل (Client ID) الذي تستخدمه هذه الصفحة |
مثال — افتح المحادثة من زر "تحدث معنا" الخاص بك:
<button onclick="KeydaBot.open()">Chat with us</button>يتم تحميل السكريبت بشكل غير متزامن، لذا قد لا يكون
window.KeydaBot موجوداً للحظة بعد تحميل الصفحة. قم بربط المعالجات بنقرة بدلاً من استدعائها أثناء تحليل الصفحة.كيف يتصرف على صفحتك
- تفتح اللوحة فوق زر التشغيل، الذي يبقى في مكانه ويصبح عنصر التحكم في الإغلاق. النقر عليه مرة أخرى، أو النقر على ✕ في الرأس، أو الضغط على زر Escape يغلق الدردشة.
- يمكن للزائر توسيع اللوحة من الرأس — حيث تمتد لتشمل ارتفاع النافذة وبعرض يصل إلى 760 بكسل — ويتم حفظ هذا الاختيار في متصفحه. على الهواتف، تظهر اللوحة بملء الشاشة تلقائياً، لذا لا يظهر هذا التحكم هناك.
- يغير إعداد حجم الشعار الشعار نفسه وليس الزر: المشغل عبارة عن شكل بيضاوي ثابت بحجم 52 بكسل (58 بكسل للأشكال الدائرية والمربعة) ويكبر الشعار بداخله.
- يتم عرض كل شيء داخل shadow root، لذا لا يمكن لـ CSS الخاص بموقعك التأثير على الأداة، ولا يمكن لـ CSS الخاص بالأداة التأثير على موقعك.
- لا يتم تحميل اللوحة إلا عندما يفتحها الزائر، لذا فهي لا تبطئ سرعة صفحتك.
- تستمر محادثة الزائر لمدة 24 ساعة إذا عاد مرة أخرى، ثم تبدأ من جديد.
- إذا تعذر الوصول إلى المساعد، تعرض الأداة رسالة قصيرة ولا تتسبب أبداً في ظهور خطأ على صفحتك.