Kapsam Yönetimi

Her API anahtarı, erişebileceği endpoint’leri kısıtlayan bir kapsam (scope) listesiyle oluşturulur. Bu, servis-bazlı entegrasyonlarda minimum yetki ilkesini uygulamanıza olanak tanır.

Mevcut Kapsamlar

Kapsam	Açıklama
`posts:read`	Gönderileri, şablonları, hashtag gruplarını ve kuyruğu listeleme/görüntüleme
`posts:write`	Gönderi oluşturma, güncelleme, silme; medya yükleme; şablon ve hashtag yönetimi
`analytics:read`	Analitik verileri ve kullanım istatistiklerini görüntüleme
`webhooks:manage`	Webhook endpoint’lerini oluşturma, güncelleme, silme ve test etme
`workspaces:read`	Workspace bilgilerini listeleme ve görüntüleme

Endpoint — Kapsam Matrisi

Postlar

Endpoint	Method	Gerekli Kapsam
`/v1/posts`	`GET`	`posts:read`
`/v1/posts`	`POST`	`posts:write`
`/v1/posts/{id}`	`GET`	`posts:read`
`/v1/posts/{id}`	`PATCH`	`posts:write`
`/v1/posts/{id}`	`DELETE`	`posts:write`
`/v1/posts/{id}/status`	`GET`	`posts:read`
`/v1/posts/{id}/duplicate`	`POST`	`posts:write`
`/v1/posts/bulk`	`POST`	`posts:write`

Medya

Endpoint	Method	Gerekli Kapsam
`/v1/media`	`GET`	`posts:read`
`/v1/media/{id}`	`GET`	`posts:read`
`/v1/media/{id}`	`DELETE`	`posts:write`
`/v1/media/upload`	`POST`	`posts:write`

Analitik & Kullanım

Endpoint	Method	Gerekli Kapsam
`/v1/analytics/overview`	`GET`	`analytics:read`
`/v1/analytics/posts`	`GET`	`analytics:read`
`/v1/analytics/accounts`	`GET`	`analytics:read`
`/v1/usage`	`GET`	`analytics:read`

Webhooklar

Endpoint	Method	Gerekli Kapsam
`/v1/webhooks`	`GET`	`webhooks:manage`
`/v1/webhooks`	`POST`	`webhooks:manage`
`/v1/webhooks/{id}`	`GET`	`webhooks:manage`
`/v1/webhooks/{id}`	`PATCH`	`webhooks:manage`
`/v1/webhooks/{id}`	`DELETE`	`webhooks:manage`
`/v1/webhooks/{id}/test`	`POST`	`webhooks:manage`

Diğer

Endpoint	Method	Gerekli Kapsam
`/v1/accounts`	`GET`	`posts:read`
`/v1/workspaces`	`GET`	`workspaces:read`
`/v1/templates`	`GET`	`posts:read`
`/v1/templates`	`POST, PATCH, DELETE`	`posts:write`
`/v1/hashtags`	`GET`	`posts:read`
`/v1/hashtags`	`POST, PATCH, DELETE`	`posts:write`
`/v1/queue`	`GET`	`posts:read`
`/v1/queue`	`POST, PATCH, DELETE`	`posts:write`
`/v1/me`	`GET`	(kapsam gerekmez)

/v1/me endpoint’i geçerli bir API anahtarıyla herhangi bir kapsam gerektirmeden erişilebilir. Anahtar doğrulama ve temel profil bilgisi için kullanılır.

Yetersiz Kapsam Hatası

Anahtarınızda ilgili kapsam yoksa API 403 Forbidden döner:


{
  "success": false,
  "error": {
    "code": "FORBIDDEN_SCOPE",
    "message": "Bu işlem için 'posts:write' yetkisi gereklidir.",
    "details": {}
  }
}

Kapsam Tasarım Önerileri

İzolasyon prensibi: Her servis veya entegrasyon için yalnızca ihtiyaç duyduğu kapsamları içeren ayrı bir API anahtarı oluşturun.


// Yalnızca analitik çeken bir servis için:
// Kapsamlar: ["analytics:read"]
 
// İçerik planlama botu için:
// Kapsamlar: ["posts:read", "posts:write"]
 
// Tam yetkili yönetim paneli için:
// Kapsamlar: ["posts:read", "posts:write", "analytics:read", "webhooks:manage", "workspaces:read"]