أسماء الحقول ورموز الأخطاء وأمثلة الشيفرة بالإنجليزية، كما تستخدمها في برنامجك.
المصادقة
مفاتيح API والصلاحيات والبيئات وتدويرها.
أرسل مفتاحك في ترويسة Authorization مع كل طلب:
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_. كلاهما يعمل على مساحة العمل نفسها، والتسمية تساعدك على الفصل بين بيئة التجربة والإنتاج. استخدم مفتاحًا لكل بيئة حتى تتمكن من إلغاء أحدهما دون المساس بالآخر.
تدوير المفتاح
- أنشئ مفتاحًا جديدًا بالصلاحيات نفسها.
- انشره على خوادمك.
- راقب آخر استخدام للمفتاح القديم حتى يتوقف عن التغيّر، ثم ألغِه.
يمكن أيضًا إنشاء المفاتيح بمدة انتهاء (٣٠ أو ٩٠ أو ٣٦٥ يومًا).
التحقق من المفتاح
curl https://deewan.io/api/v1/me -H "Authorization: Bearer $DEEWAN_API_KEY"