Bölüm 24

bbbserver.de IntegrationAPI

IntegrationAPI üzerindeki bbbserver.de, standart BigBlueButton API’sini yansıtan ve arka planda konferansları yeterli kapasiteye sahip birden fazla sunucuya dağıtan bir proxy’dir.

API URL’si ve Paylaşılan Gizli Anahtar Nerede Bulunur

API URL’niz ve shared secret, bbbserver yönetici panelinde Entegrasyonlar ve API’ler → Integration-API altında bulunur. IntegrationAPI burada etkinleştirilebilir veya devre dışı bırakılabilir.

bbb-conf kullanırken kimlik bilgilerini almak için shell erişimine veya bbbserver.de komutlarına ihtiyacınız yoktur.

Plugin Uyumluluğu

Aşağıdaki platformlar kutudan çıktığı gibi çalışır. Çoğu durumda yalnızca API URL’sini ve shared secret değerini standart BigBlueButton entegrasyonuna girmeniz yeterlidir.

  • Moodle (BigBlueButtonBN)
  • ILIAS
  • Nextcloud
  • WordPress
  • Greenlight

Standart API'den Farklar

IntegrationAPI, standart BBB API’sini yakından yansıtır, ancak bbbserver.de üzerindeki bazı davranışlar entegrasyon sırasında açıkça anlaşılması gerekecek kadar farklıdır.

Kapasite Rezervasyonu

IntegrationAPI üzerinden bir konferans oluşturduğunuzda, bbbserver.de bunu yeterli boş kaynağa sahip bir arka uç sunucusuna atamak zorundadır. Bu nedenle maxParticipants ve duration, yalnızca beklenen kullanımı belgelemekten ziyade bağlantı ve çalışma süresi kapasitesi için bir rezervasyon talebi işlevi görür.

Bu nedenle her iki değer de create çağrılarında sağlanmalıdır. Atlanırlarsa, Entegrasyonlar ve API’ler → Integration-API içindeki varsayılanlar kullanılır.

Kapasite Rezervasyonu Örneği

Aşağıdaki örnek, rezervasyon tabanlı kapasite planlamasının normal tek sunucu varsayımına kıyasla davranışı nasıl değiştirdiğini gösterir:

Durum Kapasite Üzerindeki Etki
Hesabınız 20 eşzamanlı bağlantıya izin veriyor Bu, etkin rezervasyonlar için kullanılabilir toplam bağlantı havuzudur.
maxParticipants = 15 ve duration = 120 minutes ile Konferans A oluşturulur Konferans A, tam iki saatlik rezervasyon penceresi boyunca mevcut 20 bağlantının 15’ini rezerve eder.
Bu iki saat içinde başka bir konferans oluşturulur Konferans A hâlâ ayrılmış zaman penceresi içindeyken, kalan 5 bağlantıdan fazlasını rezerve edemez.
İki saat dolmuştur ve Konferans A hâlâ devam etmektedir Konferans A devam edebilir, ancak ayrılmış kapasitesi artık garanti edilmez veya korunmaz.
Daha sonra maxParticipants = 10 ile Konferans B oluşturulur Sistem, Konferans A artık etkin bir rezervasyonla korunmadığı için Konferans B lehine Konferans A’yı otomatik olarak sonlandırabilir.

"duration" parametresinin davranışı

bbbserver.de üzerinde duration, kapasite planlamasının bir parçasıdır ve yapılandırılan süre aşıldığında bir toplantıyı otomatik olarak sonlandırmaz.

duration, bbbserver.de üzerinde bu rezervasyon anlamına sahip olduğundan, yapılandırılan sürenin aşılması bir toplantıyı asla otomatik olarak bitirmez. İş akışınız sabit bir bitiş zamanı gerektiriyorsa, açık bir end API çağrısı planlayın.

White-labeling için Ek Parametre

deactivateBbbserverDefaultChatTexts, true veya false kabul eder ve varsayılan olarak false değerine sahiptir.

false olarak kaldığı sürece, bbbserver.de kendi çevirmeli katılım talimatlarını ve barındırma bildirimini içeren sohbet metnini ekler. Daha sonra sizin welcome ve moderatorOnlyMessage metinleriniz eklenir. White-labeling için bu varsayılan bbbserver metinlerini devre dışı bırakmak istiyorsanız parametreyi true olarak ayarlayın.

Kullanılamayan Uç Noktalar

Aşağıdaki API çağrıları standart API’de vardır, ancak IntegrationAPI tarafından uygulanmamıştır:

updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack

Webhook'lar

Hook’lar belirli toplantı kimlikleri için kaydedilmelidir. Toplantı kimliği belirtmeden tüm toplantılar için kayıt desteklenmez.

Webhook olayları hassas bilgiler içerebilir. Bu nedenle bbbserver.de, gizlilik açısından hassas alanları otomatik olarak kaldırır veya belirsizleştirir; bu yüzden katılımcı IP adresleri gibi veriler kullanılamayabilir.

Hız Sınırları

IntegrationAPI üzerinde hız sınırı yoktur.

IntegrationAPI'ye ek olarak bbbserver.de, hesap yönetimi ve kullanım istatistikleri gibi platforma özgü özellikler içeren ayrı bir System API sunar. System API, BBB uyumlu değildir ve bu kılavuzda ele alınmamaktadır.

Sıkça Sorulan Sorular

bbbserver yönetici panelini açın ve Entegrasyonlar ve API’ler → Integration-API bölümüne gidin. Burada API URL’sini görüntüleyebilir, shared secret değerini kopyalayabilir ve IntegrationAPI öğesini etkinleştirebilir veya devre dışı bırakabilirsiniz.

IntegrationAPI; Moodle, ILIAS, Nextcloud, WordPress ve Greenlight gibi standart BigBlueButton entegrasyonlarıyla çalışacak şekilde tasarlanmıştır.

bbbserver.de IntegrationAPI, standart BBB API’sini yansıtır; ancak maxParticipants ve duration kapasite rezerve eder, toplantılar otomatik olarak sonlandırılmaz, deactivateBbbserverDefaultChatTexts platform sohbet metinlerini kontrol eder, bazı uç noktalar kullanılamaz ve webhook’lar toplantıya özeldir.

İstek günlüğünü geçici olarak etkinleştirebilirsiniz. Etkin olduğu sürece IntegrationAPI öğesine gönderilen tüm istekler kaydedilir. Bu, API’nin kendisini test etmenizi, kendi entegrasyonunuzu denemenizi ve API’nin pratikte nasıl davrandığını incelemenizi sağlar.