Keyda Business
Saudi ArabiaEnglish تسجيل الدخول ابدأ مجاناً
وثائق Keyda Businessمرجع

مرجع SDK

كل حزمة تطوير برمجيات من Keyda — Android، وiOS، وReact Native، وFlutter، وIonic — تنفذ نفس العقد البسيط. إذا استخدمت واحدة منها، فقد استخدمتها جميعاً.

واجهة برمجة التطبيقات (API)

اتصالما الذي يفعله
init / initializeيخزن Client ID الخاص بك. يقوم بالتحقق منه ويصدر تنبيهاً واضحاً إذا كان بتنسيق خاطئ.
showيعرض الدردشة فوق تطبيقك.
dismissيغلقها.
isShowingما إذا كان يتم عرضه الآن.

لا يوجد شيء آخر عمداً. لا توجد واجهة برمجة تطبيقات لإرسال الرسائل، ولا عداد للرسائل غير المقروءة، ولا استدعاء لهوية المستخدم — لأن أياً من هذه لا يعمل من البداية إلى النهاية بعد، والطريقة التي لا تعمل هي أسوأ من الطريقة المفقودة.

الرابط (URL) الذي يفتحه كل SDK

{baseUrl}/chat/{clientId}

baseUrl يتم تعيينه افتراضياً إلى https://keyda.in/business ويمكن تجاوزه على أي منصة، سواء للبيئة التجريبية أو للتثبيت الذاتي.

لماذا تحتاج إلى عرض ويب، وما هي تكلفته عليك

هناك واجهة دردشة واحدة، يتم تقديمها بواسطة المنصة، وتقوم جميع الواجهات بتحميلها.

ما تحصل عليه: أي تغيير يجريه المالك في لوحة التحكم — لون التمييز، رسالة الترحيب، اسم الـ bot، تفعيل الخدمة — يصل إلى كل تطبيق على الفور، دون الحاجة لإصدار جديد. أي إصلاح يطبق في كل مكان في وقت واحد. الدردشة متطابقة عبر جميع المنصات.

التكلفة: تحتاج المحادثة إلى اتصال. لا يوجد وضع غير متصل بالإنترنت، ولا توجد إشعارات دفع حتى الآن.

نفضل أن تعرف هذا قبل الإطلاق بدلاً من اكتشافه لاحقاً.

الضمانات التي تقدمها كل حزمة تطوير برمجيات (SDK)

  1. خروج التنقل. أي رابط لمصدر خارجي يفتح في متصفح النظام بدلاً من استبدال نافذة الدردشة. بدون هذا، نقرة واحدة على رابط في التذييل ستنهي محادثة العميل دون وسيلة للعودة.
  2. استمرارية المحادثة. تم تفعيل تخزين DOM، لذا يجد العميل الذي يغلق التطبيق ويعود إليه محادثته في المكان الذي توقف عنده (لمدة 24 ساعة).
  3. لوحة المفاتيح لا تغطي حقل الإدخال أبداً.
  4. يتم احترام المناطق الآمنة — لا يتم رسم الدردشة تحت نتوء الشاشة أو مؤشر الصفحة الرئيسية.
  5. لا يصل أي عطل إلى تطبيقك. فشل التحميل يظهر خيار إعادة المحاولة.
  6. لا توجد تحليلات، ولا معرفات أجهزة، ولا تبعيات من أطراف خارجية. إضافة Keyda SDK لا تضيف أي متتبع إلى تطبيقك.

تنسيق Client id

kb_live_ followed by 8-48 hexadecimal characters

أي شيء آخر يتم رفضه عند البدء بدلاً من فتح صفحة 404 أمام العميل. معرف العميل (Client ID) عام بطبيعته — فهو مرئي في أي موقع ويب يدمج الأداة — ولا يحمل أي قدرة على قراءة أو تغيير حسابك. انظر الحدود والأمان.

المصدر

عام، مرخص بموجب MIT: github.com/KeydaAI/keyda-business-sdks. العقد المشترك الذي تلتزم به كل حزمة موجود في CONTRACT.md في أعلى ذلك المستودع.

Next: Limits and security →