Hesap
API Anahtarları ve Geliştirici Erişimi
Kapsule gives you two developer surfaces: scoped API keys for reading your account programmatically, and a remote build cache that speeds up Turborepo and Nx builds on your own machines and CI…
API Keys and Developer Access
Kapsule size geliştiricilere iki yüzey sağlar: hesabınızı programlı olarak okumak için kapsamlı API anahtarları ve Turborepo ile Nx derlemelerini kendi makinelerinizde ve CI çalıştırıcılarında hızlandıran uzak bir derleme önbelleği.
İkisi de varsayılan olarak etkin değildir. Her ikisi de Settings menüsünden oluşturulur ve her ikisi de bir parolayı tam olarak bir kez verir.
API Anahtarı Oluşturma
API anahtarları Settings altında, sonra Security altında, API Keys kartında bulunur.
- Settings öğesine gidin, ardından Security öğesini seçin.
- API Keys öğesine gidin ve New key öğesini tıklatın.
- Anahtara bir ad verin. Alan "Key name (e.g. My automation script)" öğesini önerir. Ad yalnızca sizin için olduğundan, anahtarın nerede kullanılacağını yazın.
- Anahtarın yapabileceği şeyi seçmek için kapsam çiplerine tıklayın. Üç okuma kapsamı önceden seçilidir:
read:sites,read:emailveread:domains. Bir çipi eklemek veya kaldırmak için tıklayın. - Create öğesini tıklatın.
Tam anahtar bir kez görünür, "Copy now" başlıklı yeşil bir panelde. Doğrudan gizli deponuza kopyalayın. Bu paneli kapatırsan anahtar kaybolur: yalnızca kısa bir ön ek saklanır; bu, listenin size tekrar gösterebileceği tek şeydir.
Anahtar ikinci kez gösterilmez ve kurtarılamaz. Kaybederseniz, bu anahtarı iptal edin ve yeni bir tane oluşturun. Bunu paylaşılan bir belgede, bir istekte, bir taahhütte veya bir sohbet mesajında yapıştırmayın.
Yalnızca Owner ve Admin rolleri bir anahtar oluşturabilir. Diğer herhangi bir rol bir izin hatası alır. Bir anahtar oluşturulduğunda, onu kim oluşturduysa o kişinin adresine bir güvenlik uyarısı e-postası gönderilir, bu nedenle beklenmeyen biri değerlendirilmeye değer.
Kapsamlar
Yedi kapsam sunulmaktadır:
| Kapsam | İzin verir |
|---|---|
read:sites | Web sitelerinizi okuma |
write:sites | Web sitelerinde yazma işlemleri için ayrılmış |
read:email | Posta kutularınızı okuma |
write:email | Posta kutularında yazma işlemleri için ayrılmış |
read:domains | Alan adlarınızı okuma |
write:domains | Alan adlarında yazma işlemleri için ayrılmış |
read:billing | Faturalandırma verilerini okumak için ayrılmış |
Müşteri API'si bugün yalnızca okunurdur. write: kapsamları ve read:billing bir anahtarda seçilebilir, ancak hiçbir müşteri uç noktası bunları tüketmez, bu nedenle bunları vermek hiçbir şeyi değiştirmez. Yalnızca ihtiyacınız olan okuma kapsamlarını verin ve yazma uç noktaları sevk edildiğinde anahtarı yeniden ziyaret edin.
Anahtarı Kullanma
Anahtarı Authorization başlığında taşıyıcı token olarak gönderin.
curl https://kpanel.kapsulehost.com/api/v1/sites \
-H "Authorization: Bearer YOUR_KEY_HERE"
Üç uç nokta bir müşteri API anahtarını kabul eder:
| Uç nokta | Gereken kapsam | Döner |
|---|---|---|
GET /api/v1/sites | read:sites | Web siteleriniz, etki alanı, uygulama türü ve durumuyla birlikte |
GET /api/v1/domains | read:domains | Alan adlarınız, durum ve son kullanma tarihi ile birlikte |
GET /api/v1/mailboxes | read:email | Posta kutularınız |
Anahtar olmayan, bilinmeyen veya iptal edilen bir anahtarla yapılan istek 401 döner. Doğru kapsamı olmayan geçerli bir anahtar, gerekli kapsamı adlandıran bir mesajla 403 döner. Her başarılı çağrı anahtarın son kullanılan zaman damgasını günceller.
Nazikçe yoklayın. Bu uç noktalar canlı hesap verilerini okur ve bunlara karşı sıkı bir döngü suistimalden ayırt edilemez. Bir pano ihtiyaç duyduğu herhangi bir şey için dakikada bir; bir saat içinde genellikle yeterlidir.
Anahtarları İnceleme ve İptal Etme
API Keys tablosu her etkin anahtarı Name, Prefix (anahtarın görünür başlangıcı) ve Scopes ile listeler. Bir satırın sonunda Revoke öğesini tıklatarak onu silin.
İptal etme hemen etkili olur ve onay iletişim kutusu yoktur. Bu anahtarı kullanan bir sonraki istek 401 ile başarısız olur. İptal edilen bir anahtar geri yüklenemez, bu nedenle tıklamadan önce neyin kullandığını bildiğinizden emin olun.
Anahtarlar kişiye değil, account öğesine aittir. Team sayfasından bir takım arkadaşını kaldırmak, yaptıkları anahtarları iptal etmez. Anahtar incelemesini işten çıkarmaya dahil edin: kişiyi kaldırın, ardından buraya gelin ve oluşturdukları her şeyi iptal edin.
Anahtar oluşturma ve iptal etme her ikisi de denetim günlüğünde api_key.* eylemler altında, oyuncu ve kaynak IP adresiyle kaydedilir.
Uzak Derleme Önbelleği
Ayarlar rayının Gelişmiş grubundaki Developer sayfası bir Remote Build Cache sunmaktadır. Panel bunu "Turborepo ve Nx derlemelerini makineler ve CI ardışık hatları arasında dağıtılmış bir önbellek paylaşarak hızlandırmanın" bir yolu olarak tanımlar.
- Settings öğesine gidin, ardından Developer öğesini seçin.
- Enable remote cache öğesini tıklatın.
- "New token generated. Copy it now, it won't be shown again" başlıklı panelden belirteci kopyalayın.
Ardından CI yapılandırmanızda veya yerel .env.local dosyasında iki ortam değişkeni ayarlayın:
TURBO_TOKEN=<your-token>
TURBO_TEAM=<your-account-id>
Takım ID'si, aynı sayfadaki kurulum talimatlarında gösterilen Kapsule hesap ID'sidir.
Sayfa kendi uyumluluğunu belirtir: Turborepo 1.x ve sonrası, Nx 16 ve sonrası ve aynı uzak önbellek protokolünü uygulayan herhangi bir araç. Yapılar hesap başına depolanır ve hiçbir zaman hesaplar arasında paylaşılmaz.
Kartın üzerinde iki başka denetim bulunur:
- Rotate token yeni bir belirteç verir ve eskisini geçersiz kılar. Eski belirteci tutan herhangi bir CI işi önbelleği kullanmayı durdurur, bu nedenle gizli verilerinizi döndürün ve güncelleyin.
- Disable önbelleği tamamen kapatır.
İkisi Arasında Seçim Yapma
İlişkisiz sorunları çözerler ve birbirinin yerine geçemezler.
Kapsule dışındaki bir şeyin hesabınızın durumunu bilmesi gerektiğinde API key kullanın: sitelerinizi listeleyen bir durum panosu, alan adlarının yakında sona ereceğini sizi uyaran bir komut dosyası, bir envanter dışa aktarması.
Derlemeleriniz yavaş olduğunda remote build cache kullanın çünkü her makine ve her CI çalışması aynı değişmemiş paketleri yeniden derler. Barındırılan sitelerinizle ilgisi yoktur ve hesap verilerinizi okumaz.
Git'ten dağıtıyorsanız bir API aramak yerine, bunun yerine Kapsule Orbit öğesine bakın. Depo doğrudan derler ve gönderir, derleme önbelleği sizin için işlenir.
Sorun Giderme
Her istek 401 döner. Başlığı Authorization: Bearer <key> olarak tek bir boşlukla gönderdiğiniz, anahtarın kopyaladığınız zaman kesilmediği ve iptal edilmediği konusunu onaylayın. Anahtarınızın başlangıcını, kullandığınız anahtardan emin olduğunuzdan Prefix sütunuyla karşılaştırın.
Bir istek kapsamı adlandıran 403 döner. Anahtarın bu kapsamı taşımaz. Kapsamlar anahtar oluşturulduğunda sabittir, bu nedenle doğru kapsamlara sahip bir değiştirme oluşturun ve eskisini iptal edin.
API Keys kartını göremiyorum. Developer sayfasında değil, Security sayfasındadır. Developer sayfası yalnızca derleme önbelleğini tutar.
New key düğmesi hiçbir şey yapmaz. Rolünüz Admin'in altındadır. Owner veya Admin'e sorun.
Derlemeler önbelleği isabet etmiyor. Hem TURBO_TOKEN hem de TURBO_TEAM derleme ortamında bulunduğundan, belirtecin ayarladığınızdan bu yana döndürülmediğinden ve sayfanın yine de Active rozeti gösterdiğinden emin olun.
Oluşturmadığım bir anahtar göründü. Onu uzlaşma olarak ele alın. İptal edin, ardından Account Security aracılığıyla çalışın ve denetim günlüğünü ne kadar değiştiğini kontrol edin.