Ağ geçidi API anahtarlarını yönetin

Ağ geçidi API anahtarı, bir makine istemcisinin CID222'yi çağırmak için sunduğu taşıyıcı belirteçtir — sohbet uç noktasına istek gönderen bir uygulama, tespit çalıştıran bir betik ya da çağıranı doğrulayan bir vekil sunucu. Her anahtar tam olarak tek bir hesaba ya da tek bir kiracı grubuna bağlıdır; bir hız sınırı ve isteğe bağlı aylık kotalar taşır.

Anahtar oluşturun

Bir anahtarı kullanın

İstemci anahtarı taşıyıcı belirteç olarak gönderir:

curl -sS https://<appliance-fqdn>/chat/completions \
  -H "Authorization: Bearer cid_key_0123456789abcdef..." \
  -H "Content-Type: application/json" \
  -d '{"model":"gpt-4o","provider":"openai","messages":[{"role":"user","content":"hello"}]}'

Bir cid_key_, oturum açmış bir kullanıcıyı ya da bir anahtarı kabul eden uç noktalara erişir: sohbet tamamlama uç noktası, arkasındaki oturumlar, tespit API'si ve önde duran bir vekil sunucunun kullandığı servisler arası anahtar doğrulaması. Yönetim yüzeyine erişmez — her /admin uç noktası rolü olan, oturum açmış bir hesap gerektirir ve bir anahtarın rolü yoktur.

Bir anahtarı değiştirin

Bir anahtarı iptal edin

Grup anahtarındaki kimlik uyarısı

Planlamanız gereken iki sonuç:

• O üyeyi gruptan çıkarmak anahtarı iptal etmez. Anahtarın kimliğini artık en erken eklenmiş olan kişiye aktarır ve anahtarın altında çalıştığı politikayı da beraberinde taşır.
• Üyeliği boş olan bir grup, anahtarın hiç kimseye çözümlenmemesine yol açar; ağ geçidi de arkasında hesap olmayan bir isteği kabul etmek yerine reddeder.

Atfın kararlı olmasını istediğiniz her yerde anahtarı tekil bir hesaba bağlayın. Bugün pratik yanıt, adanmış bir servis hesabıdır.

Alan başvurusu

Liste sütunları

Anahtarlar nasıl saklanır

Bir anahtar, cid_key_ önekinin ardından onaltılık olarak 32 rastgele bayttan oluşur. Cihaz, SHA-256 özetini ve gösterim için ilk 12 karakteri saklar — anahtarın kendisini asla — bu nedenle kaybedilen bir anahtar cihazdan geri alınamaz, yalnızca değiştirilebilir. Son Kullanım zaman damgası anahtar başına en fazla dakikada bir yazılır; dolayısıyla çok yeni bir çağrı hemen yansımayabilir.

Veri modelinde anahtarların isteğe bağlı bir son kullanma tarihi vardır (tarihi olmayan bir anahtarın süresi hiç dolmaz), ancak pano 0.4 sürümünde böyle bir alan sunmaz. İhtiyacınız varsa API üzerinden belirleyin.

Doğrulama

1. Yeni anahtar, belirlediğiniz sahip, sınır ve durumla listede görünür ve Son Kullanım sütunu Hiç gösterir.
2. Ağ geçidini anahtarla çağırın. Başarılı bir çağrı bir tamamlama döndürür ve satırın Son Kullanım değeriyle kota sayaçları bir dakika içinde ilerler.
3. İptal edilmiş bir anahtarla çağırın. Ağ geçidi 401 ve API key is not active yanıtını verir.
4. Anahtar değişiklikleri 0.4 sürümünde denetim izine yazılmaz — RESOURCE_CREATED, RESOURCE_UPDATED ya da RESOURCE_DELETED satırı üretilmez. Anahtar ile yapılan istekler, anahtarın çözümlendiği hesap altında olağan trafik olarak kaydedilir.

Başarısız olursa

• Invalid API key (401) — anahtar, saklanan hiçbir özetle eşleşmiyor. Yanlış yazılmış ya da yeniden üretilmiştir.
• API key is not active (401) — anahtar pasif ya da iptal edilmiştir.
• API key has expired (401) — anahtarın süresi geçmiş bir son kullanma tarihi taşıyordu.
• API key request quota exceeded / API key token quota exceeded (401) — aylık kota tükenmiştir. Sınırı yükseltin ya da sayaçların sıfırlanmasını bekleyin.
• Invalid expires_at: {value} / expires_at must be in the future — betikle yapılan bir çağrı bozuk ya da geçmiş bir son kullanma tarihi gönderdi.
• API key with ID {id} not found — anahtar yok ya da sahibi olmadığınız bir birime ait. Yeniden üretme de birebir aynı biçimde reddeder ve hiçbir şey yazmaz.
• 403 ile reddedilen bir oluşturma — belirttiğiniz hesap kapsamınızın dışındadır. Sahibi olmadığınız bir grup, var olmayan bir grupla aynı 404 yanıtını verir; bu bilinçlidir, böylece yanıt birimleri sıralamaz.
• Failed to create API key / Failed to regenerate API key / Failed to revoke API key — ağ geçidi yazmayı reddetti; yukarıdaki ilgili ileti buna eşlik eder.
• Only administrators can manage API keys. — rolünüz bu sayfayı kullanamaz.

Sonraki adımlar

• API anahtar testi — yeni ürettiğiniz anahtarla gerçek bir sohbet isteği gönderip yanıtı okuyun.
• Kimlik bilgileri — herhangi bir anahtarın işe yarayabilmesi için ağ geçidinin ihtiyaç duyduğu sağlayıcı anahtarları.
• Kiracı grupları — bir grup anahtarının ödünç aldığı kimliğin belirlendiği yer.