الانتقال إلى المحتوى الرئيسي
تتيح ودجة موقع Gorbit تضمين المحادثة المدعومة بالذكاء الاصطناعي مباشرة على أي موقع. تشمل الميزات:
  • حزمة خفيفة ~100-150 كيلوبايت مضغوطة بـ gzip
  • ألوان وعلامة تجارية قابلة للتخصيص بالكامل
  • تصميم متجاوب (نافذة منبثقة لسطح المكتب، شاشة كاملة للجوال)
  • استجابات دفق في الوقت الفعلي عبر SSE
  • استمرار الجلسة عبر إعادة تحميل الصفحة

​
خيارات النشر

​
النشر السحابي (موصى به)

لمستخدمي Gorbit Cloud، يتم تقديم الودجة من CDN لـ Gorbit. ببساطة أضف ما يلي إلى موقعك: 
<!-- تحميل الودجة -->
<script type="module" src="https://cdn.gorbit.app/widget/1.0/dist/gorbit-widget.js"></script>

<!-- التكوين والعرض -->
<gorbit-chat-widget
  backend-url="https://cloud.gorbit.app/api"
  api-key="your_api_key_here"
  mode="launcher"
>
</gorbit-chat-widget>

​
نشر الاستضافة الذاتية

لمثيلات Gorbit المستضافة ذاتيًا، ستحتاج إلى بناء واستضافة الودجة بنفسك.
1

استنساخ المستودع

استنسخ مستودع Gorbit من GitHub.
2

الانتقال إلى مجلد الودجة

cd widget/
3

تثبيت التبعيات

npm install
4

الحصول على مفتاح API للودجة

انتقل إلى لوحة مشرف Gorbit وأنشئ مفتاح API جديد خصيصًا للودجة.Creating a widget API key in the Gorbit admin panel
أنشئ مفتاح API محدود النطاق بصلاحيات المحادثة فقط. لا تستخدم أبدًا مفاتيح المشرف أو الوصول الكامل لأن مفتاح API سيكون مرئيًا في الكود من جانب العميل.
5

تكوين البيئة (اختياري)

للبنيات مع تكوين مدمج، أنشئ ملف .env:
cp .env.example .env
عدّل .env واضبط رابط الخلفية ومفتاح API:
VITE_WIDGET_BACKEND_URL=https://your-backend.com
VITE_WIDGET_API_KEY=your_api_key
6

بناء الودجة

لـ النشر السحابي (التكوين عبر سمات HTML):
npm run build:cloud
لـ النشر المستضاف ذاتيًا (التكوين مدمج في الحزمة):
npm run build:self-hosted
7

نشر الحزمة

حمّل dist/gorbit-widget.js إلى CDN أو خادم الويب الخاص بك.

​
كود التضمين للعميل

بعد النشر، زوّد العملاء بكود التضمين: النمط السحابي (السمات مطلوبة): 
<script type="module" src="https://your-cdn.com/gorbit-widget.js"></script>
<gorbit-chat-widget
  backend-url="https://your-backend.com"
  api-key="customer_api_key"
  agent-name="Support"
  logo="https://path-to-your-logo.com/"
>
</gorbit-chat-widget>
المستضاف ذاتيًا (التكوين مدمج): 
<script type="module" src="https://your-cdn.com/gorbit-widget.js"></script>
<gorbit-chat-widget
  agent-name="Support"
  logo="https://path-to-your-logo.com/"
>
</gorbit-chat-widget>

​
مرجع التكوين

​
السمات المطلوبة

السمةالنوعالوصف
backend-urlstringرابط واجهة Gorbit الخلفية
api-keystringمفتاح API للمصادقة

​
backend-url

رابط واجهة Gorbit الخلفية. هنا ترسل الودجة طلبات المحادثة.
  • Gorbit Cloud: استخدم https://cloud.gorbit.app أو رابط المستأجر الخاص بك
  • مستضاف ذاتيًا: استخدم رابط مثيل Gorbit (مثلاً، https://gorbit.yourcompany.com)
<!-- Gorbit Cloud -->
<gorbit-chat-widget backend-url="https://cloud.gorbit.app/api" ...></gorbit-chat-widget>

<!-- مستضاف ذاتيًا -->
<gorbit-chat-widget backend-url="https://gorbit.yourcompany.com" ...></gorbit-chat-widget>

​
api-key

مفتاح Gorbit API صالح لمصادقة طلبات الودجة. هذا المفتاح مرئي في الكود من جانب العميل، لذا استخدم دائمًا مفتاحًا محدود النطاق. 
<gorbit-chat-widget
  backend-url="https://cloud.gorbit.app/api"
  api-key="on_abc123xyz789"
  ...
></gorbit-chat-widget>
للبنيات المستضافة ذاتيًا مع تكوين مدمج، يمكن تعيين backend-url و api-key عبر متغيرات البيئة أثناء البناء بدلاً من سمات HTML.

​
السمات الاختيارية

السمةالنوعالافتراضيالوصف
agent-idnumberundefinedوكيل/شخصية محددة للاستخدام
agent-namestring"Assistant"اسم العرض في الرأس
logostringشعار Gorbitرابط لصورة شعار مخصص
primary-colorstring#1c1c1cاللون الأساسي للعلامة التجارية (الأزرار، المؤشرات)
background-colorstring#e9e9e9لون خلفية الودجة
text-colorstring#000000bfلون النص (أسود بشفافية 75%)
modestring"launcher"وضع العرض: "launcher" أو "inline"

​
أمان مفتاح API

مفتاح API للودجة مكشوف في الكود من جانب العميل. أنشئ دائمًا مفتاح API مخصص مع:
  • أذونات محدودة - وصول المحادثة فقط، لا ميزات المشرف
  • تحديد المعدل - منع الإساءة من الجهات الخبيثة
  • المراقبة - تتبع الاستخدام واكتشاف الحالات الشاذة
1

إنشاء مفتاح API خاص بالودجة

في لوحة مشرف Gorbit، أنشئ مفتاح API جديد بأذونات دنيا.
2

تفعيل تحديد المعدل

قم بتكوين حدود المعدل المناسبة لاستخدامك المتوقع.
3

مراقبة الاستخدام

راجع بانتظام استخدام مفتاح API للأنماط غير المعتادة.

​
دعم المتصفحات

  • Chrome/Edge 90+ (Chromium)
  • Firefox 90+
  • Safari 15+
  • Mobile Safari (iOS 15+)
  • Mobile Chrome (Android)
تحتاج مساعدة في الإعداد؟ تواصل مع مسؤول Gorbit لتكوين مفتاح API أو المساعدة في النشر.