KapsuleHost size geliştirici yüzeyi sunuyor: hesabınızı programlamayla okumak için kapsamlı API anahtarları ve Turborepo ile Nx derlemelerinizi kendi makinelerinizde ve CI koşucularında hızlandıran uzak derleme önbelleği.
İkisi de varsayılan olarak etkinleştirilmez. Her ikisi de Ayarlar'dan oluşturulur ve her ikisi de sırrı tam olarak bir kez verir.
API Anahtarı Oluşturma
API anahtarları Ayarlar'ın altında, sonra Güvenlik'in altında, API Anahtarları kartında bulunur.
- Ayarlar'a, sonra Güvenlik'e gidin.
- API Anahtarları'na kaydırın ve Yeni anahtar'ı tıklayın.
- Anahtara bir ad verin. Alan "Anahtar adı (ör. Otomasyonum betiği)" olacak şekilde önerir. Ad sadece sizin için, bu yüzden anahtarın nerede kullanılacağını yazın.
- Anahtarın yapabileceğini seçmek için kapsam çiplerini tıklayın. Üç okuma kapsamı önceden seçilir:
read:sites,read:emailveread:domains. Bir çipi eklemek veya kaldırmak için tıklayın. - Oluştur'u tıklayın.
Tam anahtar bir kez, "Şimdi kopyala" başlığı olan yeşil bir panelde görünür. Bunu doğrudan gizli deponuza kopyalayın. Bu paneli kapatırken anahtar kaybolur: sadece kısa bir önek saklanır, bu da listenin size gösterebileceği her şeydir.
Anahtar ikinci kez asla gösterilmez ve kurtarılamaz. Kaybederseniz, o anahtarı iptal edin ve yeni bir tane oluşturun. Paylaşılan bir belgeye, bir bilete, bir katılımı veya bir sohbet iletisine yapıştırmayın.
Yalnızca Sahip ve Yönetici rolleri anahtarı oluşturabilir. Diğer herhangi bir rol izin hatası alır. Bir anahtar oluşturulduğunda, onu oluşturan kişinin adresine bir güvenlik uyarısı e-postası gider, bu nedenle bunlardan beklenmedik biri hemen araştırmaya değer.
Kapsamlar
Yedi kapsam sunulur:
| Kapsam | 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 | Etki alanlarınızı okuma |
write:domains | Etki alanlarında yazma işlemleri için ayrılmış |
read:billing | Fatura verilerini okumak için ayrılmış |
Müşteri API'si bugün salt okunurdur. write: kapsamları ve read:billing bir anahtarda seçilebilir, ancak hiçbir müşteri uç noktası şu anda bunları tüketmez, bu nedenle bunları vermek hiçbir şeyi değiştirmez. Yalnızca gerçekten ihtiyaç duyduğunuz okuma kapsamlarını verin ve yazma uç noktaları kullanıma sunulduğunda anahtarı yeniden gözden geçirin.
Anahtar Kullanma
Anahtarı Authorization başlığında taşıyıcı belirteç olarak gönderin.
curl https://kpanel.kapsulehost.com/api/v1/sites \
-H "Authorization: Bearer YOUR_KEY_HERE"
Üç uç nokta müşteri API anahtarını kabul eder:
| Uç nokta | Gerekli kapsam | Döndürür |
|---|---|---|
GET /api/v1/sites | read:sites | Web siteleriniz, etki alanı, uygulama türü ve durum ile |
GET /api/v1/domains | read:domains | Etki alanlarınız, durum ve son kullanma tarihi ile |
GET /api/v1/mailboxes | read:email | Posta kutularınız |
Anahtar olmayan, bilinmeyen veya iptal edilen bir anahtar ile bir istek 401 döndürür. Gerekli kapsam olmayan geçerli bir anahtar 403 döndürür ve ihtiyaç duyulan kapsamı adlandıran bir ileti ile. Her başarılı çağrı, anahtarın son kullanılan zaman damgasını günceller.
Kıvılcım yavaşça. Bu uç noktalar canlı hesap verilerini okur ve bunlara karşı sıkı bir döngü kötüye kullanımdan ayırt edilemez. Pano ihtiyaçları için dakikada bir kez çok cömert, saatte bir kez genellikle yeterlidir.
Anahtarları İnceleme ve İptal Etme
API Anahtarları tablosu her etkin anahtarı Ad, Önek (anahtarın görünür başlangıcı) ve Kapsamlar ile listeler. Bir satırın sonundaki İptal et'i tıklatarak öldürün.
İptal etme hemen geçerli olur ve onay iletişim kutusu yoktur. Bu anahtarı kullanan 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 onu oluşturan kişiye değil hesaba aittir. Bir takım arkadaşını Takım sayfasından kaldırmak, oluşturdukları anahtarları iptal etmez. Offboarding'e bir anahtar incelemesi yapılandırın: kişiyi kaldırın, sonra buraya gelin ve oluşturdukları hiçbir şeyi iptal edin.
Anahtar oluşturma ve iptal, her ikisi de denetim günlüğünde api_key.* eylemleri altında, aktör ve kaynak IP adresi ile kaydedilir.
Uzak Derleme Önbelleği
Ayarlar rayının Gelişmiş grubundaki Geliştirici sayfası bir Uzak Derleme Önbelleği sunuyor. Panel bunu "Turborepo ve Nx derlemelerinizi makineler ve CI boru hatları arasında dağıtılmış bir önbelleği paylaşarak hızlandırmak" için bir yol olarak açıklar.
- Ayarlar'a, sonra Geliştirici'ye gidin.
- Uzak önbelleği etkinleştir'i tıklayın.
- Belirteci "Yeni belirteç oluşturuldu. Şimdi kopyalayın, tekrar gösterilmeyecek" başlığı olan panelden kopyalayın.
Sonra CI yapılandırmanızda veya yerel .env.local'da iki ortam değişkeni ayarlayın:
TURBO_TOKEN=<your-token>
TURBO_TEAM=<your-account-id>
Takım kimliği, aynı sayfadaki kurulum talimatlarında gösterilen KapsuleHost hesap kimliğinizdir.
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ıtlar hesap başına depolanır ve hiçbir zaman hesaplar arasında paylaşılmaz.
Kart üzerinde iki kontrol daha bulunur:
- Belirteci döndür yeni bir belirteç verir ve eskisini geçersiz kılar. Eski belirteci tutan herhangi bir CI işi önbelleği kullanmayı durduruyor, bu nedenle döndürüp gizli dizilerinizi birlikte güncelleyin.
- Devre dışı bırak önbelleği tamamen kapatır.
İkisi Arasında Seçim Yapmak
İlişkisiz sorunları çözerler ve birbirinin yerine kullanılamaz.
KapsuleHost dışında bir şey hesabınızın durumunu bilmesi gerektiğinde bir API anahtarı kullanın: sitelerinizi listeleyen bir durum panosu, yakında sona erecek etki alanları konusunda sizi uyaran bir betik, bir envanter dışa aktarma.
Derlemeleriniz yavaş olduğunda uzak derleme önbelleği kullanın çünkü her makine ve her CI çalıştırması aynı değiştirilmemiş paketleri yeniden oluşturuyor. Barındırılan siteleriniz ile ilgili hiçbir şeyi yoktur ve hesap verilerinizi okumaz.
Sorun Giderme
Her istek 401 döndürüyor. Başlığı Authorization: Bearer <key> olarak tek boşluk ile gönderdiğinizi, anahtarın kopyalandığında kesilmediğini ve iptal edilmediğini doğrulayın. Anahtarınızın başlangıcını kullandığınız anahtarı emin olmak için Önek sütunu ile karşılaştırın.
Bir istek 403 adlandıran bir kapsam döndürüyor. Anahtar bu kapsamı taşımıyor. Kapsamlar anahtar oluşturulduğunda sabittir, bu nedenle doğru kapsamları ile bir yedek oluşturun ve eskisini iptal edin.
API Anahtarları kartını göremiyorum. Geliştirici sayfasında değil, Güvenlik sayfasındadır. Geliştirici sayfası yalnızca derleme önbelleğini tutar.
Yeni anahtar düğmesi hiçbir şey yapmıyor. Rolünüz Yönetici'nin altında. Sahip veya bir Yönetici'den isteyin.
Derlemeler önbelleği isabet etmiyor. Her ikisi de TURBO_TOKEN ve TURBO_TEAM derleme ortamında mevcut olduğundan, belirtecin onu ayarladığınızdan beri döndürülmediğinden ve sayfa hala Etkin rozeti gösterdiğinden emin olun.
Oluşturmadığım bir anahtar görüntülendi. Bunu bir tehlikenin oluşması olarak değerlendirin. İptal edin, sonra Hesap Güvenliği üzerinden çalışın ve başka neyin değiştiğini görmek için denetim günlüğünü kontrol edin.