Zoom Cobrowse SDK

# Zoom Cobrowse SDK - تطوير الويب

مرجع خلفية لاستعراض الويب التعاوني مع Zoom Cobrowse SDK. استخدم هذا بعد توضيح سير العمل الداعم وتحتاج إلى تفاصيل التنفيذ.

**التوثيق الرسمي**: https://developers.zoom.us/docs/cobrowse-sdk/ **مرجع API**: https://marketplacefront.zoom.us/sdk/cobrowse/ **مستودع البدء السريع**: https://github.com/zoom/CobrowseSDK-Quickstart **عينة نقطة نهاية المصادقة**: https://github.com/zoom/cobrowsesdk-auth-endpoint-sample

## روابط سريعة

**جديد في Cobrowse SDK؟ اتبع هذا المسار:**

1. **[دليل البدء](get-started.md)** - الإعداد الكامل من بيانات الاعتماد إلى الجلسة الأولى 2. **[دورة حياة الجلسة](concepts/session-lifecycle.md)** - فهم تدفقات العميل والوكيل 3. **[مصادقة JWT](concepts/jwt-authentication.md)** - توليد التوكن والأمان 4. **[تكامل العميل](examples/customer-integration.md)** - دمج SDK في موقعك الإلكتروني 5. **[تكامل الوكيل](examples/agent-integration.md)** - إعداد بوابة الوكيل (iframe أو npm)

**المفاهيم الأساسية:** - **[نمط الأدوار الثنائية](concepts/two-roles-pattern.md)** - معمارية العميل مقابل الوكيل - **[دورة حياة الجلسة](concepts/session-lifecycle.md)** - توليد PIN والاتصال وإعادة الاتصال - **[مصادقة JWT](concepts/jwt-authentication.md)** - SDK Key مقابل API Key وnRole_type والمطالبات - **[طرق التوزيع](concepts/distribution-methods.md)** - CDN مقابل npm (BYOP)

**الميزات:** - **[أدوات التعليق التوضيحي](examples/annotations.md)** - أدوات الرسم والتمييز والمؤشر - **[إخفاء البيانات الحساسة](examples/privacy-masking.md)** - إخفاء الحقول الحساسة عن الوكلاء - **[المساعدة عن بعد](examples/remote-assist.md)** - يمكن للوكيل التمرير في صفحة العميل - **[استمرارية متعددة الألسنة](examples/multi-tab-persistence.md)** - تستمر الجلسة عبر الألسنة - **[وضع BYOP](examples/byop-custom-pin.md)** - إحضر PIN خاص بك مع تكامل npm

**استكشاف الأخطاء:** - **[المشاكل الشائعة](troubleshooting/common-issues.md)** - التشخيص السريع والحلول - **[رموز الأخطاء](troubleshooting/error-codes.md)** - مرجع الأخطاء الكامل - **[CORS و CSP](troubleshooting/cors-csp.md)** - تكوين الأصول المتعددة وسياسة الأمان - **[توافق المتصفح](troubleshooting/browser-compatibility.md)** - المتصفحات المدعومة والقيود - **[دليل سريع 5 دقائق](RUNBOOK.md)** - فحوصات سريعة قبل تصحيح الأخطاء الشامل

**مرجع:** - **[مرجع API](references/api-reference.md)** - طرق وأحداث SDK الكاملة - **[مرجع الإعدادات](references/settings-reference.md)** - جميع إعدادات التهيئة - **الفهرس المتكامل** - انظر القسم أدناه في هذا الملف

## نظرة عامة على SDK

مكتبة Zoom Cobrowse SDK هي مكتبة JavaScript توفر:

- **استعراض تعاوني في الوقت الفعلي**: الوكيل يرى نشاط متصفح العميل مباشرة - **جلسات قائمة على PIN**: رمز PIN آمن مكون من 6 أرقام لاتصال العميل بالوكيل - **أدوات التعليق التوضيحي**: الرسم والتمييز والقلم المختفي والمستطيل ومنتقي الألوان - **إخفاء البيانات الحساسة**: إخفاء قائم على محدد CSS للحقول الحساسة - **المساعدة عن بعد**: يمكن للوكيل التمرير في صفحة العميل (بموافقته) - **استمرارية متعددة الألسنة**: تستمر الجلسة عندما يفتح العميل ألسنة جديدة - **إعادة الاتصال التلقائي**: تتعافى الجلسة من تحديث الصفحة (نافذة 2 دقيقة) - **أحداث الجلسة**: أحداث فورية لتغييرات حالة الجلسة - **HTTPS مطلوب**: اتصالات آمنة (HTTP يعمل فقط على loopback/أجهزة التطوير المحلية) - **بدون ملحقات**: JavaScript نقي بدون حاجة إلى ملحقات المتصفح

## معمارية الأدوار الثنائية

يتضمن استعراض Zoom **دورين متميزين**، لكل منهما أنماط تكامل مختلفة:

| الدور | role_type | التكامل | JWT مطلوب | الغرض | |------|-----------|---------|----------|--------| | **العميل** | 1 | تكامل الموقع (CDN أو npm) | نعم | المستخدم الذي يشارك جلسة متصفحه | | **الوكيل** | 2 | Iframe (CDN) أو npm (BYOP فقط) | نعم | موظف الدعم الذي يشاهد/يساعد العميل |

**فكرة أساسية**: يستخدم العميل والوكيل **طرق تكامل مختلفة** لكن نفس نمط مصادقة JWT.

## اقرأ هذا أولا (حرج)

للعروض التوضيحية للعميل/الوكيل، تعامل مع PIN من حدث SDK للعميل `pincode_updated` كرمز PIN الوحيد الموجه للمستخدم.

- اعرض قيمة واحدة واضحة ومسماة في واجهة المستخدم (على سبيل المثال، **رمز PIN الدعم**). - استخدم نفس PIN لجلسة الوكيل. - لا تكشف عن PINs مؤقتة/تصحيح من سجلات ما قبل البدء في الواجهة الخلفية للمستخدمين.

إذا تم تجاهل هذه القواعد، فإن مكتب الوكيل غالبا ما يفشل مع `Pincode is not found` / الكود `30308`.

### تدفق الإنتاج النموذجي (الأكثر شيوعا)

هذا هو التدفق الذي تطبقه معظم الفرق أولا، وما يتوقعه المستخدمون عادة في العروض التوضيحية:

1. **يبدأ العميل الجلسة أولا** (`role_type=1`) - الواجهة الخلفية تنشئ/تسجل الجلسة - الواجهة الخلفية تعيد JWT العميل - SDK العميل يبدأ ويستقبل PIN 2. **الوكيل ينضم ثانيا** (`role_type=2`) - يدخل الوكيل PIN العميل - الواجهة الخلفية تتحقق من PIN وحالة الجلسة - الواجهة الخلفية تعيد JWT الوكيل - الوكيل يفتح iframe مكتب Zoom المستضاف (أو واجهة مستخدم وكيل npm مخصصة في BYOP)

إذا كان العرض التوضيحي يحتوي على وكيل واحد فقط