API Anahtarı En İyi Uygulamaları

API anahtarları, ajan hesabınıza ve kaynaklarınıza erişim sağlayan hassas kimlik bilgileridir. Bunları korumak, uygulamalarınızın ve verilerinizin güvenliğini korumak için çok önemlidir. Bu kılavuz, ajan API anahtarlarınızı güvenli bir şekilde yönetmek için en iyi uygulamaları özetlemektedir.

• Manage Workspace API Keys — Çalışma alanı yöneticileri, Çalışma Alanı Ayarları → Ürünler → API'de çalışma alanı API anahtarlarını oluşturur, görüntüler ve iptal eder.

Erişimi olan üyeler, hesap ayarlarında personal API keys oluşturur ve yönetir.

API Anahtar Güvenliği Neden Önemlidir?

ajan API anahtarlarınız, hesabınızın yapay zeka yeteneklerine ve verilerine erişim sağlar. Güvenliği ihlal edilirse yetkisiz kullanıcılar şunları yapabilir:

• Ajan kaynaklarınıza erişin ve beklenmedik maliyetlere maruz kalın
• Uygulamalarınız aracılığıyla işlenen hassas verileri açığa çıkarın
• Hesabınızı kötü amaçlarla kötüye kullanmak
• Kuruluşunuzun uyumluluk gereksinimlerini ihlal etmek

API Anahtar Yönetimi için En İyi Uygulamalar

API Anahtarlarını Hiçbir Zaman Sabit Kodlama

Bunu yapmayın:

from openai import OpenAI

client = OpenAI(
    base_url="https://api.ajan.io/openai/eu/v1",
    api_key="sk-ld-a1b2c3d4e5f6g7h8i9j0..."  # Never do this!
)

Kaynak kodunuzdaki API anahtarlarını sabit kodlamak, bunları sürüm kontrol geçmişi de dahil olmak üzere kod tabanınıza erişimi olan herkesin kullanımına sunar.

Ortam Değişkenlerini Kullan

API anahtarlarınızı kodunuz yerine ortam değişkenlerinde saklayın. Bu, yapılandırmayı koddan ayırır ve ortamlar arasında farklı anahtarların yönetilmesini kolaylaştırır.

Bunun yerine şunu yapın:

1. Proje dizininizde bir .env dosyası oluşturun ve API anahtarınızı ekleyin:

AJAN_API_KEY=your-api-key-here

2. python-dotenv paketini yükleyin:

pip install python-dotenv

3. API anahtarınızı Python betiğinize yükleyin:

from dotenv import load_dotenv
from openai import OpenAI
import os

load_dotenv()

client = OpenAI(
    base_url="https://api.ajan.io/openai/eu/v1",
    api_key=os.environ.get("AJAN_API_KEY")
)

Anahtarları Sürüm Kontrolünden Uzak Tutun

Yanlışlıkla işlenmesini önlemek için hassas kimlik bilgileri içeren dosyaları .gitignore dosyanıza ekleyin:

# .gitignore
.env
.env.local
config/secrets.yml
credentials.json

Farklı Kullanım Durumları için Farklı Anahtarlar Kullanın

Kişisel API anahtarları bir üyenin kimliğine ve kullanım bütçesine bağlıdır. Asla kişisel bir API anahtarını paylaşmayın. Paylaşılan her uygulama, ortam veya ekip için ayrı bir çalışma alanı API anahtarı kullanın. Bu uygulama:

• Bir anahtarın ele geçirilmesi durumunda etkiyi sınırlar
• Uygulamaya veya ekibe göre kullanımın izlenmesine yardımcı olur
• Anahtar döndürmeyi kolaylaştırır
• Daha iyi denetim yolları sağlar

Örneğin, aşağıdakiler için ayrı anahtarlar kullanın:

• Geliştirme ve üretim ortamları
• Ajan API'sini kullanan farklı uygulamalar
• Kuruluşunuzdaki farklı ekipler veya departmanlar

Tarayıcı İsteklerinde API Anahtarlarını Asla Göstermeyin

Önemli: ajan, tarayıcı tabanlı API isteklerini desteklemez. ajan API, sunucular arası iletişim için özel olarak tasarlanmıştır. Bir tarayıcıdan doğrudan API çağrıları yapmaya çalışmak CORS (Çapraz Kökenli Kaynak Paylaşımı) hatalarına neden olur.

API anahtarları hiçbir zaman istemci tarafı kodunda gösterilmemelidir çünkü bunlar:

• Tarayıcı ağ trafiğinde görünür
• Tarayıcı geliştirici araçlarıyla erişilebilir
• JavaScript kaynak kodundan çıkarılabilir
• Uygulamanızın herhangi bir kullanıcısına açık

Arka uç sunucunuz, yukarıda açıklanan en iyi uygulamaları kullanarak API anahtarını güvenli bir şekilde saklamalı ve kullanıcılarınız adına ajan'a istekte bulunmalıdır.

Anahtar Rotasyonunu Uygulayın

Uzun süreli maruz kalma riskini en aza indirmek için API anahtarlarınızı düzenli olarak değiştirin. Kişisel bir API anahtarı için hesap ayarlarınızda Anahtarı döndür seçeneğini seçin ve bağlı her aracı yeni anahtarla güncelleyin. Bir çalışma alanı API anahtarı için manuel olarak döndürün:

1. Yeni bir API anahtarı oluşturun
2. Uygulamalarınızı yeni anahtarı kullanacak şekilde güncelleyin
3. Geçişin başarılı olduğundan emin olmak için izleyin
4. Yeni anahtarın çalıştığını doğruladıktan sonra eski anahtarı iptal edin

Anahtarları en az 90 günde bir veya tehlikeden şüpheleniyorsanız hemen döndürmenizi öneririz.

Kullanımı İzleyin ve Sınırları Ayarlayın

Güvenliği ihlal edilmiş bir anahtarı gösterebilecek olağandışı kalıpları tespit etmek için ajan kontrol panelindeki API kullanımınızı düzenli olarak inceleyin. Sızdırılan anahtarlardan kaynaklanan beklenmeyen masraflara karşı koruma sağlamak için mümkün olan yerlerde kullanım uyarıları ve harcama limitleri ayarlayın.

API Anahtarınız Ele Geçirilirse Ne Yapmalısınız?

API anahtarınızın açığa çıktığından şüpheleniyorsanız:

1. Anahtarı derhal iptal edin, hesap ayarlarınızdaki kişisel anahtarları ve Çalışma Alanı Ayarları → Ürünler → API'deki çalışma alanı anahtarlarını
2. Yeni bir anahtar oluşturun
3. Yeni anahtarı kullanmak için uygulamalarınızı güncelleyin
4. İzinsiz kullanım olup olmadığını görmek için hesap etkinliğinizi inceleyin
5. Şüpheli bir etkinlik fark ederseniz ajans desteğiyle iletişime geçin**
6. Güvenlik kayıtlarınız için olayları belgeleyin

Yardıma mı ihtiyacınız var?

API anahtarı güvenliği hakkında sorularınız varsa veya ajan hesabınızla ilgili yardıma ihtiyacınız varsa:

• support@ajan.com adresinden destek ekibimizle iletişime geçin
• Ek bilgi için Hizmet Koşullarımızı ve Gizlilik Politikamızı inceleyin

Unutmayın: API anahtarı güvenliği tek seferlik bir kurulum değil, devam eden bir uygulamadır. Güvenlik önlemlerinizin düzenli olarak gözden geçirilmesi ve güncellenmesi, ajan hesabınızın ve uygulamalarınızın güvende kalmasına yardımcı olacaktır.