البدء باستخدام واجهة برمجة تطبيقات Webex Events
list-menuهل لديك ملاحظات؟
ما تفعله واجهة برمجة التطبيقات وكيفية البدء

إذا كان لديك مطور في فريقك يعرف كيفية استخدام واجهة برمجة تطبيقات GraphQL، فقد تكون Webex Events API بوابتك إلى عمليات التشغيل الآلي القوية لإعداد وإدارة الأحداث والمنتجات، وتكامل النظام الأساسي لجهات خارجية، ولوحات بيانات قوية متعددة الأحداث، والمزيد.

ما الذي يمكن أن تفعله واجهة برمجة تطبيقات Webex Events

ببساطة، API هي واجهة برمجة يمكن للمطورين استخدامها للحصول على البيانات أو وضعها في منصة عبر الإنترنت - في هذه الحالة، Webex Events.

يمكن تبسيط قدرات API إلى أربعة مفاهيم أساسية:

  • قم بإنشاء شيء لم يكن موجودًا من قبل، مثل أحد الحاضرين أو الجلسة أو الحدث بأكمله.

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

  • اقرأ معلومات حول أي شيء يمكن استخدام واجهة برمجة التطبيقات لإنشائه أو تحريره، بالإضافة إلى بعض الأشياء التي لا يمكن استخدامها.

  • احذف أي شيء يمكن استخدام واجهة برمجة التطبيقات لإنشائه، مع بعض الاستثناءات.

ضع هذه المفاهيم في الاعتبار أثناء قراءة قسم «العمل مع المطورين» من هذه المقالة.

كيفية البدء

1. احصل على الوصول إلى API

إذا كنت أحد عملاء اتفاقية Webex Suite المؤسسة (Suite EA) وقمت بالفعل بتنشيط Webex Events، يمكنك الوصول تلقائيًا إلى واجهة برمجة تطبيقات Webex Events! بالنسبة لجميع العملاء الآخرين، تحدث إلى جهة اتصال Webex Events الخاصة بك أو فريق الدعم لدينا لمعرفة كيفية الوصول إلى API.

2. قم بإنشاء مفتاح API

أنت الآن بحاجة إلى إنشاء مفتاح API جديد ليستخدمه المطورون. عندما تتمكن من الوصول إلى API، تتم إضافة علامة تبويب جديدة إلى صفحة «إعدادات المؤسسة» في منصة Webex Events. فيما يلي كيفية الوصول إلى علامة التبويب الجديدة وإنشاء مفتاحك الأول:

ضع في اعتبارك أن مسؤولي المؤسسة فقط هم من يمكنهم الوصول إلى صفحة API.

  1. من أي مكان في منصة Webex Events، انقر فوق صورة ملف التعريف الخاص بك في الزاوية اليمنى العليا من الشاشة، ثم حدد إعدادات المؤسسة من القائمة المنسدلة.

  2. في صفحة إعدادات المؤسسة، انقر فوق علامة تبويب API في القائمة اليسرى. ينقلك هذا إلى لوحة معلومات API حيث يمكنك مراجعة استخدام API وتصدير سجلات الاستخدام وإدارة المفاتيح والوصول إلى وثائق API الخاصة بنا.

  3. انقر فوق إنشاء مفتاح.

  4. في نموذج «إنشاء مفتاح جديد»، أدخل تسمية لمفتاح API الذي يشرح الغرض الذي سيتم استخدامه من أجله.

  5. سيتم تحديد الإصدار الحالي بالفعل في القائمة المنسدلة لإصدار API، لذا ما عليك سوى النقر فوق حفظ. هذا يكشف عن مفتاح API.

  6. انقر فوق زر النسخ بجوار المفتاح والصق المفتاح في مستند آمن لضمان عدم فقده أبدًا.

تحذير! هذه هي المرة الوحيدة التي يمكن فيها الوصول إلى مفتاح API الكامل. بعد إغلاق النموذج، لا يمكن قراءة المفتاح الكامل مرة أخرى.

  1. بعد نسخ المفتاح وحفظه، انقر فوق زر الإغلاق.

في معظم الحالات، تحتاج فقط إلى مفتاح API واحد. ومع ذلك، في الحالات التي تعمل فيها مع فرق متعددة، قد ترغب في إنشاء مفتاح لكل فريق. تحدث إلى المطورين حول حالات الاستخدام المحددة لمعرفة الحل الأفضل.

3. قم بدعوة المطورين للوصول إلى API

عند إنشاء مفتاح API الأول، يتم إنشاء فريق API جديد تلقائيًا في منصة Webex Events. إن منح المطورين إمكانية الوصول لتجربة Webex Events API أمر بسيط مثل دعوتهم إلى فريق API هذا. اتبع التعليمات الواردة في مقالتنا حول إدارة الفرق والأعضاء والاعتمادات لمعرفة كيفية القيام بذلك.

ضع في اعتبارك أن API sandbox هو إصدار منفصل من منصة Webex Events المصممة خصيصًا للاختبار. هذا يعني أنه يجب على جميع الأعضاء الجدد في فريق API Sandbox إنشاء حساب منصة جديد لاستخدام sandbox، حتى إذا كان لديهم بالفعل حساب منصة أو تسجيل الدخول باستخدام SSO الخاص بمؤسستهم.

لا يستطيع الأشخاص في فريق API الخاص بك الوصول إلى بقية منصة Webex Events بالطريقة التي يقوم بها المنظمون. بدلاً من ذلك، يمكن لأعضاء فريق API الوصول إلى «وضع الحماية» لواجهة برمجة التطبيقات حيث يمكنهم اختبار ما يقومون ببنائه دون التأثير على بيانات العالم الحقيقي. إذا كنت تريد أن يتمكن المطورون أيضًا من الوصول إلى بعض أو كل الأحداث والتطبيقات الحقيقية الخاصة بك في منصة Webex Events، فقم بدعوتهم إلى الفرق ذات الصلة غير التابعة لـ API.

4. كن لطيفًا مع مطوريك

هذا أمر بالغ الأهمية، لذلك جعلنا الأمر خطوة كاملة. 😉

«لم يتم بناء روما في يوم واحد»، ولم يكن أيضًا تكاملًا جيدًا لواجهة برمجة التطبيقات. كن صديقًا جيدًا لمطوريك وامنحهم متسعًا من الوقت للتعرف على واجهة برمجة تطبيقات Webex Events قبل أن تتوقع منهم تقديم عمليات تكامل. سيكونون ممتنين لعدم التعرض للضغط.

على الأقل، نوصي ببدء المحادثات مع المطورين قبل ستة أشهر على الأقل من الحاجة إلى عمل عمليات الدمج. استمر في القراءة لمعرفة كيفية الاستعداد لتلك المحادثات وإجراؤها.

العمل مع المطورين

بعد دعوة المطورين إلى فريق Webex Events Sandbox الخاص بك، قد يكون أحد أسئلتك الأولى هو «كم من الوقت سيستغرق إنشاء عمليات تكامل؟» تعتمد الإجابة على هذا السؤال على العديد من العوامل، بما في ذلك عدد المطورين الذين تعمل معهم، ومقدار الوقت الذي يتعين عليهم العمل فيه على عمليات الدمج، ومدى تعقيد عمليات الدمج، والمزيد.

يمكن للمطورين فقط إخبارك بالوقت الذي سيستغرقه التكامل للإعداد، وفقط بعد بضع خطوات مهمة:

  1. أولاً، اقرأ الأقسام أدناه لمعرفة ما يمكن أن تفعله واجهة برمجة التطبيقات. سيساعدك هذا على فهم ما هو ممكن حتى تتمكن من توصيل احتياجاتك بوضوح مع المطورين.

  2. اجتمع مع المطورين وشارك وثائق API الخاصة بنا معهم وناقش ما تريد. سيتمكنون من تقديم ملاحظات أساسية حول ما يمكنهم فعله وما لا يمكنهم فعله من أجلك. ومع ذلك، لن يتمكنوا من إعطائك جداول زمنية محددة حتى يكونوا على دراية بواجهة برمجة تطبيقات Webex Events.

  3. امنح المطورين وقتًا للتعرف على واجهة برمجة التطبيقات. كن متاحًا للإجابة على الأسئلة المفاهيمية أو العملية حول الأحداث والبيانات ومنصة Webex Events وأي شيء آخر.

ما يمكن أن تفعله واجهة برمجة التطبيقات

تحتوي واجهة برمجة التطبيقات على وظيفتين أساسيتين:

  • اقرأ - احصل على البيانات من Webex Events حتى تتمكن من فحصها أو سحبها إلى نظام مختلف.

  • التحديث - ضع البيانات في Webex Events لإنشاء عناصر جديدة أو مزامنة البيانات، مثل الحاضرين، من منصة أخرى. أي شيء يغير شيئًا ما في منصة Webex Events هو تحديث.

الفرق والمنظمات

  • إنشاء الفرق وأعضاء الفريق وتحديثهم وقراءتهم وحذفهم

أحداث

  • التحديث والاستنساخ والقراءة. لا يمكن إنشاء الأحداث أو حذفها باستخدام API.

الحاضرون

  • قم بإنشاء وتحديث وقراءة وتخصيص الجلسات والتعيين للمجموعات وحذف معلومات الحساب الاجتماعي (رقم الهاتف ومقابض الحسابات الاجتماعية وما إلى ذلك). لا يمكن حذف الحاضرين، على الرغم من إمكانية حظرهم.

أسئلة

  • الإنشاء والتحديث والقراءة والحذف

نصيحة: في واجهة برمجة التطبيقات، تسمى الأسئلة «الحقول المخصصة»

المجموعات

  • إنشاء المجموعات الحصرية وغير الحصرية وتحديثها وقراءتها وحذفها

جلسات

  • الإنشاء والتحديث والقراءة والحذف

مواقع

  • الإنشاء والتحديث والقراءة والحذف

نصيحة: في واجهة برمجة التطبيقات، تسمى المواقع «المناطق».

تطبيقات ذات علامة تجارية

  • اقرأ أسماء التطبيقات ذات العلامات التجارية وحالاتها وأسماء الأحداث المعينة

تطبيق الأحداث

  • اقرأ الأساسيات والمظهر Web App والإعدادات بالإضافة إلى معلومات تسجيلات مركز الفيديو

  • يمكنك إنشاء ميزات Event App التالية وعناصرها وتحديثها وقراءتها وحذفها، حيثما ينطبق ذلك:

    • جدول أعمال

    • الرعاة

    • مكبرات صوت

    • العارضون

    • بث مباشر

    • الحاضرون

    • قائمة مخصصة

    • عنصر مفرد

    • رابط الويب

    • قائمة الويب

    • رمز QR الخاص بي

ضع في اعتبارك أنه يجب إضافة أي ميزات لتطبيق الأحداث غير المدرجة أعلاه وتهيئتها يدويًا.

نصيحة: في واجهة برمجة التطبيقات، تسمى الميزات «المكونات».

التسجيل

  • اقرأ معلومات الأساسيات والمظهر والإعدادات، بما في ذلك إعدادات الدفع

  • إنشاء وقراءة وتحديث وحذف التذاكر والنماذج والأسئلة والرموز الترويجية

  • إنشاء الطلبات وقراءتها وتحديثها

  • إرسال رسائل البريد الإلكتروني لتأكيد الطلب والتذاكر

  • ضع علامة على أوامر الشيكات أو الفواتير على أنها مدفوعة

  • تحديث معلومات مشتري الطلب

  • إلغاء التذاكر واستردادها

  • إنشاء الرموز الترويجية وقراءتها وتحديثها وحذفها وإيقافها مؤقتًا واستئنافها

  • إنشاء الضرائب وقراءتها وتحديثها وحذفها

نصيحة: في واجهة برمجة التطبيقات، تسمى الأسئلة «الحقول المخصصة».

بالموقع

  • قراءة وتحديث الأساسيات ومعلومات التطبيق في الموقع

استرجاع الرصاص والعرض المباشر

  • اقرأ ما إذا كان المنتج نشطًا أو منشورًا في الحدث

أشياء يجب معرفتها

  • لا يمكن استخدام واجهة برمجة التطبيقات لإنشاء حدث أو تنشيط أي من المنتجات في الحدث، مثل تطبيق الحدث والموقع. قبل أن يتمكن المطورون من تعديل حدث باستخدام واجهة برمجة التطبيقات، يجب عليك تنشيط كل منتج تنوي استخدامه وملء المعلومات الأساسية المطلوبة لكل منتج.

  • سنصدر أحيانًا إصدارات جديدة من واجهة برمجة التطبيقات مع تحسينات وإصلاحات. سنستمر في دعم الإصدارات القديمة لفترة كافية للجميع لنقل الإصدار الجديد. سنرسل تحديثات عبر البريد الإلكتروني حول الإصدارات الجديدة وتواريخ إيقاف الإصدارات القديمة القادمة وعمليات الإيقاف الرسمية.

  • يتم قياس طلبات API وتقييدها لمنع إساءة الاستخدام.

  • يتم دعم المنتديات أيضًا لعملاء Suite.

هل كان هذا المقال مفيدًا؟
هل كان هذا المقال مفيدًا؟