Müşteri API'si ve API anahtarları
Source Bilişim müşteri API'sini kapsam kontrollü anahtarlarla güvenli biçimde kullanın.
Son güncelleme
Müşteri API'si; hesabınızı, sunucularınızı, faturalarınızı ve bildirimlerinizi kendi sunucu tarafı uygulamalarınızdan yönetmenizi sağlar.
Tüm uç noktaları, örnekleri ve OpenAPI kullanımını içeren yeni referans için Müşteri API'si kategorisini açın.
Anahtarı gizli tutun
API anahtarını tarayıcı JavaScript'ine, mobil uygulama paketine, herkese açık depoya veya destek mesajına eklemeyin. Anahtar yalnız oluşturulduğu anda tam olarak gösterilir. Açığa çıktığını düşünüyorsanız Güvenlik Merkezi'nden hemen devre dışı bırakın.
Başlangıç
- Güvenlik Merkezi → API Anahtarları bölümünü açın.
- Anahtara kullanım amacını anlatan bir ad verin.
- Yalnız gereken yetki kapsamlarını ve mümkünse sınırlı bir geçerlilik süresini seçin.
- Oluşturulan anahtarı parola yöneticinize veya sunucu tarafı secret kasanıza kaydedin.
Temel adres:
https://api.sourcebilisim.com/v1Anahtarı Bearer kimlik doğrulamasıyla gönderin:
curl -H "Authorization: Bearer sb_live_YOUR_KEY" \
https://api.sourcebilisim.com/v1/serversX-API-Key başlığı da desteklenir; standart Authorization: Bearer başlığı önerilir.
Yetki kapsamları
| Kapsam | İzin verdiği erişim |
|---|---|
account:read | Hesap kimliği, kullanıcı adı, e-posta, rol ve dilini görüntüleme |
api-logs:read | Hesaba ait API istek geçmişini görüntüleme |
servers:read | Sahip olduğunuz sunucuları ve canlı durumlarını görüntüleme |
servers:power | Minecraft sürecini başlatma, durdurma veya yeniden başlatma |
invoices:read | Hesabınıza ait faturaları görüntüleme |
notifications:read | Hesabınıza ait bildirimleri görüntüleme |
notifications:write | Bildirimleri okundu olarak işaretleme |
Her anahtar yalnız seçtiğiniz kapsamlarla çalışır. Dosyalar, konsol, SFTP, veritabanı/SQL, yedek geri yükleme, sunucu silme ve altyapı yönetimi müşteri API'sine açık değildir.
Uç noktalar
| Yöntem | Yol | Gerekli kapsam |
|---|---|---|
GET | /key | Anahtarın kendi kapsam bilgisi; ek kapsam gerekmez |
GET | /me | account:read |
GET | /request-logs | api-logs:read |
GET | /servers | servers:read |
GET | /servers/{serverId} | servers:read |
GET | /servers/{serverId}/status | servers:read |
POST | /servers/{serverId}/actions | servers:power |
GET | /invoices ve /invoices/{invoiceId} | invoices:read |
GET | /notifications | notifications:read |
PATCH | /notifications/{notificationId}/read | notifications:write |
Güç işlemi örneği:
curl -X POST \
-H "Authorization: Bearer sb_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"action":"restart"}' \
https://api.sourcebilisim.com/v1/servers/123/actionsstart, stop ve restart işlemleri LXC makinesini değil Minecraft sürecini yönetir. Askıdaki veya kurulumu tamamlanmamış sunucular başlatılamaz.
Listeleme, sınırlar ve hatalar
Sunucu, fatura ve bildirim listelerinde limit (1–100) ve before imleci kullanılabilir. Bildirimlerde yalnız okunmamış kayıtlar için unread=true ekleyebilirsiniz. Yanıttaki meta.next_cursor değerini bir sonraki istekte before olarak gönderin.
- Okuma istekleri: anahtar başına dakikada 120
- Değişiklik istekleri: anahtar başına dakikada 20
- Çoklu anahtar kullanımında hesap başına toplam sınır: dakikada 180 okuma ve 30 değişiklik
- Güç işlemleri: hesap başına dakikada 6; aynı sunucuda iki güç işlemi arasında en az 10 saniye
- Kimliği doğrulanmış istek kayıtları Güvenlik Merkezi'nde 90 güne veya hesap başına en yeni 100.000 kayda kadar görüntülenebilir.
- Kalan hak ve sıfırlanma zamanı
X-RateLimit-*başlıklarında döner. 401geçersiz, süresi dolmuş veya iptal edilmiş anahtarı;403eksik kapsamı;429istek sınırını belirtir.- Yanıtlardaki
request_iddeğerini destek taleplerinde paylaşabilirsiniz; API anahtarını paylaşmayın.
Makine tarafından okunabilir OpenAPI tanımı: https://api.sourcebilisim.com/v1/openapi.json