Skip to content

Kimlik doğrulama ve scope'lar

API anahtarları

İstekler, bearer token olarak gönderilen bir API anahtarıyla doğrulanır:

Authorization: Bearer stoneity_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  • Anahtarları çalışma alanı yöneticileri Ayarlar → Uygulamalar → API anahtarları bölümünden oluşturur.
  • Anahtar çalışma alanını tanımlar; ayrıca tenant başlığı yoktur.
  • Anahtar yenilenebilir (eski anahtar anında geçersiz olur, servis hesabı aynı kalır) ve iptal edilebilir (servis hesabı pasife alınır).
  • İsteğe bağlı bitiş tarihi verilebilir. Süresi dolan anahtar 401 ve api_key_expired kodu döner.

Anahtarları bir gizli anahtar deposunda saklayın. Sızarsa ayarlar sayfasından yenileyin.

Servis hesapları

Her anahtar, oluşturulurken seçilen role sahip bir servis hesabı kullanıcısı adına çalışır. Anahtarın yaptığı her şey bu hesabın adıyla kaydedilir. Hesap arayüze giriş yapamaz ve kullanıcı kotanıza sayılmaz. Rolün board erişim kuralları anahtara aynen uygulanır.

Scope'lar

Anahtar yalnız scope'larının kapsadığı işlemleri çağırabilir:

Scopeİzin
tickets:readKayıt, yorum ve ek listeleme/okuma
tickets:writeKayıt açma/güncelleme, durum ve atama değiştirme, yorum ve ek ekleme
boards:readBoard'lar, alanlar, seçenek listeleri ve durumlar
users:readKullanıcılar, talep sahipleri ve şirketler
users:writeKullanıcı/talep sahibi davet etme, şirket oluşturma
kb:readYayımlanmış bilgi bankası makaleleri
webhooks:manageWebhook abonelikleri ve teslimat logları

Gerekli scope yoksa 403 döner:

json
{ "errors": [ { "code": "insufficient_scope", "message": "This operation requires the `tickets:write` scope." } ] }

Ortamlar

Her anahtar stoneity_ ile başlar ve ortam bilgisi taşımaz. Anahtar oluşturulduğu çalışma alanına aittir ve yalnız orada çalışır; üretim ile test aynı biçimi kullanır.

Stoneity Public API v1