Ana içeriğe geç

Dağıtımda kullanılabilirlik

TEBHOS, https://tebhos.com adresinde tek bir dağıtım olarak çalışır. Bu başvuru belgesindeki her yol bu dağıtımda kayıtlıdır; bir tür dağıtımda bulunup diğerinde bulunmayan yol yoktur.

Değişebilen şey, bir yolun arkasındaki yeteneğin açık olup olmadığıdır. Kimlik doğrulama gerektirmeyen örnek (instance) keşif belgesi bunu features nesnesinde yayımlar; böylece istemci, elinde herhangi bir kimlik bilgisi yokken bile bu bilgiyi okuyabilir.

Örnek özellikleri

curl https://tebhos.com/api/v1/.well-known/tebhos
{
  "features": {
    "voice_enabled": true,
    "presigned_attachment_uploads": true,
    "emails_enabled": true,
    "sms_enabled": false,
    "stripe_enabled": true,
    "payment_provider": "polar",
    "self_hosted": true
  }
}
Alan Tür Açıklama
voice_enabled boolean Bir ses sunucusunun yapılandırılıp yapılandırılmadığı. Ses kanalları, aramalar ve ekran paylaşımı buna ihtiyaç duyar
presigned_attachment_uploads boolean Ek yükleme URL'lerinin nesne depolamayı (true) mı yoksa API'nin kendisini (false) mi gösterdiği. Yükleme akışı her iki durumda da aynıdır
emails_enabled boolean Bir e-posta sağlayıcısının yapılandırılıp yapılandırılmadığı; doğrulama, parola sıfırlama ve e-posta değişikliği mesajlarının teslim edilebilmesi buna bağlıdır
sms_enabled boolean Bir SMS sağlayıcısının yapılandırılıp yapılandırılmadığı. Telefon doğrulaması ve SMS ile iki adımlı doğrulama yalnızca bu değer true olduğunda kullanılabilir
stripe_enabled boolean Uyumluluk için bu adla tutulur. Premium ödemeler yapılandırıldığında true olur. Ödeme sağlayıcısının adı payment_provider alanında verilir
payment_provider string Her zaman polar. Premium ve hediye satın alımları Polar tarafından işlenir
self_hosted boolean Her zaman true. Hiçbir yolu kaldırmaz; kullanılabilirlik kararlarında göz ardı edilebilir

Kapalı bir yeteneğin arkasındaki yollar

Bir yeteneğin bayrağı false olduğunda da yolları kayıtlı kalır. Hataya güvenmek yerine, özelliği sunmadan önce bayrağı okuyun:

  • voice_enabled false iken, ses bağlantısı kimlik bilgisi veren işlemler (ör. bir ses kanalına katılmak veya arama başlatmak) 500 INTERNAL_SERVER_ERROR ile başarısız olur.
  • stripe_enabled false iken, Premium ve Faturalandırma içindeki ödeme sayfası ve faturalandırma portalı işlemleri 500 INTERNAL_SERVER_ERROR ile başarısız olur.
  • sms_enabled false iken telefon doğrulaması ve SMS ile iki adımlı doğrulama giriş noktalarını gizleyin; SMS sağlayıcısı kod teslim edemez.
  • emails_enabled false iken, e-postayla gönderilen bir kodu veya bağlantıyı bekleyen akışlar tamamlanamaz.

Kimlik bilgileri, izinler, Premium durumu ve OAuth2 kapsamları hangi yolların var olduğunu hiçbir zaman değiştirmez. Yalnızca belirli bir çağıranın bu yolları kullanıp kullanamayacağını değiştirir.