API anahtarı, bir program için parola gibi çalışır. Aynı zamanda bir harcama yetkisidir: anahtarı elinde tutan, bakiyenizi kullanabilir.
Nasıl çalışır
LLM API’leri anahtarı bir bearer token olarak ele alır. İstemci onu her istekte gönderir:
curl https://inference.broadnet.ai/v1/models \
-H "Authorization: Bearer $BROADNET_API_KEY"
RFC 6750, bearer token’ı “any party in possession of the token” (çeviri: token’ı elinde bulunduran herhangi bir tarafın) kullanabildiği token olarak tanımlar. İkinci bir doğrulama adımı yoktur. Aynı RFC’nin istemcilerin bearer token’ları her zaman TLS (https://) üzerinden göndermesi gerektiğini söylemesinin nedeni budur.
Sağlayıcı anahtarı arar, hesabı bulur, sınırları ve politikaları kontrol eder, ardından isteği karşılar veya reddeder. Eksik ya da yanlış bir anahtar genellikle 401 döndürür; IP izin listesi gibi bir politika tarafından reddedilen anahtar ise genellikle 403 döndürür.
Neden önemli
Sızan bir anahtar, API faturasının kontrolden çıkmasının en yaygın yollarından biridir, çünkü botlar herkese açık kodu gizli bilgiler için tarar. Anahtar hesap ayrıntılarını döndüren uç noktalara erişebiliyorsa veri de açığa çıkabilir. OWASP’ın gizli bilgi yönetimi önerileriyle uyumlu iyi uygulamalar:
- Anahtarları ortam değişkenlerinden veya bir gizli bilgi yöneticisinden yükleyin. Asla commit etmeyin veya container imajlarına gömmeyin.
- Her uygulamaya veya ajana kendi anahtarını verin; böylece her şeyi durdurmadan birini iptal edebilirsiniz.
- Anahtarları düzenli aralıklarla ve şüphelenilen her sızıntıdan hemen sonra yenileyin.
- Anahtarın çalıştığı yeri sınırlayın; örneğin sunucu IP’lerinden oluşan bir izin listesiyle.
BroadNet Inference’ta
BroadNet iki tür kimlik bilgisini ayırır. Çıkarım anahtarı /v1/* üzerindeki modelleri çağırır. Portal kimlik bilgisi ise hesabı otomatikleştirir: anahtarlar, izin verilen IP’ler ve satın alımlar. İkincisini tam hesap yetkisi olarak değerlendirin.
İkisi de yalnızca bir kez gösterilir. BroadNet yalnızca bir SHA-256 hash değeri saklar; bu yüzden anahtarı tekrar gösteremez. Kullandıkça öde anahtarı bir yıl geçerlidir ve bir hesapta en fazla on etkin anahtar bulunabilir. Her anahtar kendi izinli IP listesini taşıyabilir. Bir iptal veya izin listesi değişikliğinden sonra yeni istekler beş saniye içinde durur.
Sabit fiyatlı planların plan anahtarları ayrıdır ve bakiyenizden hiç düşmez. Kurulum adımları API anahtarları ve IP izin listeleri rehberinde, durum kodları ise hatalar ve yeniden denemeler rehberinde.
Sık yapılan hatalar
- İstek başlıklarının tamamını loglamak. Bu, anahtarı loglarınıza yazar.
- Bir ekip içinde tek anahtar paylaşmak. Tek bir kişinin erişimini iptal etme imkânını kaybedersiniz.
- Anahtarı desteğe göndermek. Bunun yerine
X-Request-IDbaşlığının değerini gönderin.