Örnek (instance)¶

Bir TEBHOS kurulumunun uç noktalarını, etkin özelliklerini, herkese açık yapılandırmasını ve sınırlarını kimlik doğrulaması gerektirmeyen tek bir istekle keşfedin.

Örnek keşfini al, API'nin giriş noktasıdır. Yalnızca TEBHOS kaynağını (origin) bilen bir istemci önce /.well-known/tebhos adresini okur; bu tek yanıt API taban URL'sini, Gateway WebSocket URL'sini, medya taban URL'sini, CAPTCHA sağlayıcısını ve hesaplar ile sunucular için geçerli sınırları açıklar.

Yol kimlik doğrulaması gerektirmez ve bir kimlik bilgisi yanıtta hiçbir şeyi değiştirmez. Authorization başlığı olmadan gönderildiğinde genel hız sınırından da muaftır.

Örnek keşif nesnesi¶

Keşif belgesi, tek bir kurulumun herkese açık tanımının tamamıdır. Burada listelenen her alan her zaman bulunur.

Yapı¶

Son dört alan, eski tüketiciler için korunan kısa bir eski özet niteliğindedir. Yeni istemciler gateway yerine endpoints okur.

Örnek¶

{
  "api_code_version": 1,
  "version": "0.1.0",
  "gateway": "wss://tebhos.com/ws",
  "cdn": "https://cdn.tebhos.com",
  "experiments": {},
  "endpoints": {
    "api": "https://tebhos.com/api",
    "api_client": "https://tebhos.com/api",
    "api_public": "https://tebhos.com/api",
    "gateway": "wss://tebhos.com/ws",
    "media": "https://tebhos.com/api/v1",
    "static_cdn": "https://tebhos.com",
    "marketing": "https://tebhos.com",
    "admin": "https://admin.tebhos.com",
    "invite": "https://tebhos.com",
    "gift": "https://tebhos.com",
    "webapp": "https://tebhos.com"
  },
  "captcha": {
    "provider": "hcaptcha",
    "hcaptcha_site_key": "00000000-0000-0000-0000-000000000000",
    "turnstile_site_key": null
  },
  "features": {
    "voice_enabled": true,
    "stripe_enabled": true,
    "payment_provider": "polar",
    "self_hosted": true,
    "presigned_attachment_uploads": true,
    "emails_enabled": true,
    "sms_enabled": false
  },
  "gif": {"provider": "klipy", "display_name": "KLIPY", "attribution_required": true},
  "sso": {"enabled": false, "enforced": false, "display_name": null, "redirect_uri": "https://tebhos.com/auth/sso/callback"},
  "registration": {"mode": "open", "admin_registration_urls_enabled": true},
  "community": {"single_community": false, "single_community_guild_id": null, "direct_messages_disabled": false},
  "services": {"gif_enabled": true, "youtube_enabled": false, "bluesky_enabled": false},
  "limits": {"version": 1, "traitDefinitions": ["premium"], "rules": ["..."]},
  "push": {"public_vapid_key": "BM4KrfS2..."},
  "app_public": {
    "branding": {"product_name": "TEBHOS", "icon_url": null, "symbol_url": null, "logo_url": null, "wordmark_url": null, "favicon_url": null, "theme_color": null},
    "setup": {"configured": true, "admin_url": "https://admin.tebhos.com"},
    "legal": {"terms_url": null, "privacy_url": null},
    "registration": {"collect_date_of_birth": true}
  }
}

Yukarıdaki değerler örnek amaçlıdır. Her zaman kurulumun gerçekte döndürdüğü değerleri kullanın.

Örnek uç noktaları nesnesi¶

Her değer mutlak bir URL'dir. Birkaç uç nokta aynı kaynağı paylaşıp yalnızca yolda farklılaşabilir.

Yapı¶

Kurulum ayrı alan adları yapılandırmadıkça invite ve gift varsayılan olarak web uygulaması URL'sidir.

CAPTCHA yapılandırma nesnesi¶

Kurulumun hangi CAPTCHA sağlayıcısını kullandığı ve istemcinin sınamayı çizmek için ihtiyaç duyduğu site anahtarı.

Yapı¶

hCaptcha gizli anahtarı ve site anahtarının ikisi de yapılandırılmışsa provider değeri hcaptcha, değilse iki Turnstile anahtarı da yapılandırılmışsa turnstile, aksi hâlde none olur. Anahtar yapılandırıldığı her durumda yayımlandığından, provider değeri none iken bir site anahtarı bulunabilir; dallanmayı anahtarın varlığına göre değil, provider değerine göre yapın.

CAPTCHA sağlayıcıları¶

X-Captcha-Token ve X-Captcha-Type istek başlıkları dahil sınama el sıkışması CAPTCHA işleme sayfasında anlatılmıştır.

Örnek özellikleri nesnesi¶

İstemcinin bir özelliği sunmadan önce okuduğu, kurulum geneli anahtarlar.

Yapı¶

GIF sağlayıcı nesnesi¶

GIF sağlayıcısı ve istemcinin sağlayıcı atfını göstermesi gerekip gerekmediği.

Yapı¶

İstemci, GIF seçiciyi sunup sunmayacağına karar vermek için services.gif_enabled değerini okur.

Kayıt politikası nesnesi¶

Bu kurulumda kimin hesap açabileceği.

Yapı¶

Kayıt modları¶

Değer, yönetim panelinin sakladığı ayarı yansıtır. Kayıt yolunun kendisinin neleri denetlediği için bkz. Hesap oluştur.

Topluluk politikası nesnesi¶

Kurulumun tek bir topluluk olarak çalışıp çalışmadığı ve DM'lerin kullanılabilir olup olmadığı.

Yapı¶

Hizmet kullanılabilirliği nesnesi¶

Her isteğe bağlı entegrasyonun kullanılabilir olup olmadığı.

Yapı¶

Anlık bildirim yapılandırma nesnesi¶

Kurulumun herkese açık Web Push kimliği.

Yapı¶

Sınır yapılandırma nesnesi¶

İstemcinin bir hesaba veya sunucuya uygulanan sınırları hesaplamak için değerlendirdiği sıralı kurallar.

Yapı¶

Hazır yapılandırmada üç kural vardır: default (filtre yok, her sınır anahtarını ayarlar), premium (premium özelliğine göre filtrelenir) ve very_large_guild (VERY_LARGE_GUILD sunucu özelliğine göre filtrelenir).

İstemci default kuralından başlar, ardından filtrelerinin tümü eşleşen her kuralı uygular: adını verdiği her özellik hesabın özelliklerinden biridir ve adını verdiği her sunucu özelliği sunucunun özelliklerinden biridir. Eşleşen bir kuralın değerleri, ayarladığı anahtarlar için geçerli değerlerin yerini alır.

Sınır kuralı nesnesi¶

Sınır yapılandırmasının tek bir kuralı.

Yapı¶

Yönetim panelinde düzenlenmiş bir kural fazladan kayıt tutma üyeleri (örneğin modifiedFields) taşıyabilir. İstemci tanımadığı üyeleri yok saymak ZORUNDADIR.

Örnek¶

{
  "id": "premium",
  "filters": {"traits": ["premium"]},
  "limits": {"feature_higher_video_quality": 1}
}

Sınır filtreleri nesnesi¶

Bir sınır kuralının gerektirdiği özellikler ve sunucu özellikleri.

Yapı¶

Sınır anahtarları¶

Adı feature_ ile başlayan anahtar bir özellik kapısıdır: özellik kullanılamıyorsa 0, kullanılabiliyorsa 1. Diğer her anahtar, açıklamasında belirtilen birimde bir üst sınırdır. Varsayılanlar hazır default kuralının değerleridir; bir kurulum bunları değiştirebilir.

Herkese açık uygulama yapılandırma nesnesi¶

İstemcinin herhangi biri oturum açmadan önce okuduğu marka, kurulum durumu, yasal bağlantılar ve kayıt formu ayarları. Bu değerleri yönetim paneli düzenler.

Yapı¶

Herkese açık marka nesnesi¶

Yapı¶

Herkese açık kurulum durumu nesnesi¶

Yapı¶

Herkese açık yasal yapılandırma nesnesi¶

Yapı¶

Herkese açık kayıt alanları nesnesi¶

Yapı¶

Örnek keşfini al¶

GET /.well-known/tebhos

Örnek keşif nesnesini döndürür. Kimlik doğrulama gerekmez. Yanıtta Cache-Control: no-cache bulunur; bu yüzden istemci her başlangıçta yanıtı yeniden doğrular. Web uygulaması yeni bir kurulumu fark etmek için version değerini kullanır.

Yol v1 tabanının altındadır: https://tebhos.com/api/v1/.well-known/tebhos.

Yanıt¶

Hız sınırı¶

instance:info kovasında, her istemci için dakikada 60 istek. İstemci Authorization başlığıyla, başlık göndermiyorsa IP adresiyle tanımlanır.

Örnek¶

curl https://tebhos.com/api/v1/.well-known/tebhos