Skip to content

Geliştirici Genel Bakış

Sosyabot <BASE_URL>/api/v1/*'de bir REST API sergiler. Çoğu endpoint pano oturum açma akışı tarafından verilen bir oturum cookie'si gerektirir; küçük bir alt küme Authorization header'ı üzerinden bir kişisel API token'ı kabul eder.

Kimlik doğrulama

Endpoint ailesiAuth
/api/v1/* (varsayılan)Oturum cookie'si (token, httpOnly, oturum açma / OTP doğrulamada ayarlanır).
/api/v1/public/*API token, Authorization: Bearer <token> header üzerinden, açık scope'larla.
/api/v1/auth/*Yok (oturum açma / kayıt / OAuth callback'leri).
/api/v1/webhooks/*Inbound için yok (sağlayıcı tarafından imzalanır); outbound, kayıtlı webhook secret'ına bağlıdır.

Hatalar

Hatalar tutarlı bir zarf kullanır:

json
{
  "error": {
    "code": "POST_NOT_FOUND",
    "message": "Post does not exist"
  }
}

Kodlar sabit bir enum değildir. Çoğu hata HTTP 400 ile döner; ya ERR_ önekli bir kod (örn. ERR_VALIDATION, ERR_GENERIC) ya da belirli bir servis kodu (örn. POST_NOT_FOUND, USER_NOT_FOUND, EMAIL_INVALID) içerir. code değerini kapalı bir listeye güvenmek yerine yerelleştirilmiş bir mesaja eşlemek için bir string olarak ele alın.

Sayfalama

List endpoint'leri page (1-indexed) ve pageSize (varsayılan endpoint'e göre değişir, genelde 20; maks 100) kabul eder. Yanıtlar { data, page, pageSize, total } içerir.

İlgili