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
401veapi_key_expiredkodu 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:read | Kayıt, yorum ve ek listeleme/okuma |
tickets:write | Kayıt açma/güncelleme, durum ve atama değiştirme, yorum ve ek ekleme |
boards:read | Board'lar, alanlar, seçenek listeleri ve durumlar |
users:read | Kullanıcılar, talep sahipleri ve şirketler |
users:write | Kullanıcı/talep sahibi davet etme, şirket oluşturma |
kb:read | Yayımlanmış bilgi bankası makaleleri |
webhooks:manage | Webhook 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.