Deewanالتوثيق

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

المصادقة

مفاتيح API والصلاحيات والبيئات وتدويرها.

أرسل مفتاحك في ترويسة Authorization مع كل طلب:

http
Authorization: Bearer dwn_live_k2x9…

المفاتيح تخص مساحة عمل واحدة

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

الصلاحيات

الصلاحيةتتيح
rooms:readعرض الغرف وقراءتها
rooms:writeإنشاء الغرف وتعديلها وقفلها وحذفها
meetings:readعرض الاجتماعات المجدولة وقراءتها
meetings:writeجدولة الاجتماعات وإلغاؤها
tokens:createإنشاء روابط الانضمام ورموز الوسائط
participants:readمعرفة من في الاجتماع
participants:writeكتم الأشخاص وإزالتهم وإنهاء الاجتماعات
polls:readقراءة الاستطلاعات ونتائجها
polls:writeإنشاء الاستطلاعات وإغلاقها وحذفها
breakouts:readعرض الغرف الفرعية ومن فيها
breakouts:writeبدء الغرف الفرعية وتعديلها والإعلان فيها وإنهاؤها
recordings:readعرض التسجيلات وجلب أجزائها
recordings:writeحذف التسجيلات
webhooks:manageإدارة نقاط الويب هوك

امنح كل تكامل أضيق مجموعة يحتاجها. المفتاح الذي يُدخل الأشخاص إلى غرف قائمة يكفيه rooms:read وtokens:create (نمط الانضمام فقط).

مفاتيح الإنتاج والاختبار

تبدأ المفاتيح بـ dwn_live_ أو dwn_test_. كلاهما يعمل على مساحة العمل نفسها، والتسمية تساعدك على الفصل بين بيئة التجربة والإنتاج. استخدم مفتاحًا لكل بيئة حتى تتمكن من إلغاء أحدهما دون المساس بالآخر.

تدوير المفتاح

  • أنشئ مفتاحًا جديدًا بالصلاحيات نفسها.
  • انشره على خوادمك.
  • راقب آخر استخدام للمفتاح القديم حتى يتوقف عن التغيّر، ثم ألغِه.

يمكن أيضًا إنشاء المفاتيح بمدة انتهاء (٣٠ أو ٩٠ أو ٣٦٥ يومًا).

التحقق من المفتاح

bash
curl https://deewan.io/api/v1/me -H "Authorization: Bearer $DEEWAN_API_KEY"