API anahtarları
API anahtarları, kendi sistemlerinizin Peki API'sini çağırmasını sağlar: uygulamanızın sohbet ekranı, CRM'iniz ya da sunucunuzdaki bir betik. Her anahtar tek bir çalışma alanına aittir ve bir erişim düzeyi vardır. Anahtarları Ayarlar → API anahtarları bölümünden yönetirsiniz.
API anahtarları Peki'yi çağırmak içindir. Agent'ınızın tool'larının sizin API'lerinizi çağırmak için kullandığı anahtarlar farklıdır: onlar Ayarlar → Gizli anahtarlar bölümünde durur. Bkz. Değişkenler ve gizli anahtarlar.
Anahtarları kimler yönetebilir
API anahtarlarını yalnızca yöneticiler ve sahipler görebilir, oluşturabilir ve iptal edebilir. Diğer üyeler "Çalışma alanı ayarlarını yalnızca yöneticiler değiştirebilir." mesajını görür.
Anahtar oluşturun
- Ayarlar → API anahtarları bölümüne gidin.
- Anahtara nerede kullanıldığını anlatan bir ad verin; örneğin "Mobil uygulama" ya da "CRM senkronu". En fazla 80 karakter.
- Erişim seçin: Yalnızca okuma ya da Okuma ve yazma.
- Anahtar oluştur'a tıklayın.
- Anahtarı yeşil kutudan kopyalayın. Peki şunu söyler: "Bu anahtarı şimdi kopyalayın — bir daha gösterilmeyecek."
Anahtar şöyle görünür:
psk_3QeR8v…
Her anahtar psk_ ile başlar. Peki anahtarın yalnızca bir parmak izini saklar; bu yüzden biz dahil hiç kimse onu size tekrar gösteremez. Kaybederseniz yeni bir anahtar oluşturun ve eskisini iptal edin.
Erişim düzeyleri
| Erişim | Şu rolle çalışır | Neler yapabilir |
|---|---|---|
| Yalnızca okuma | İzleyici | Veri okumak: oturumları ve mesajlarını listelemek ve okumak, dosya indirmek. |
| Okuma ve yazma | Düzenleyici | Okuma anahtarlarının yapabildiği her şey; ayrıca oturum başlatmak, mesaj göndermek, dosya yüklemek, oturumları yeniden adlandırmak, puanlamak ve çözüldü olarak kapatmak. |
Erişimi ne olursa olsun bir anahtar asla yönetici ya da sahip olarak çalışmaz. Bu yüzden hiçbir anahtar:
- üye davet edemez, değiştiremez ya da kaldıramaz,
- API anahtarı oluşturamaz ya da iptal edemez,
- agent'ları veya çalışma alanını silemez,
- yalnızca insanlara açık olan onayları karara bağlayamaz.
Her anahtara ihtiyacı olan en az erişimi verin. Yalnızca konuşmaları gösteren bir pano için Yalnızca okuma yeter. Uygulamanızın sohbet ekranı Okuma ve yazma ister.
Anahtarı kullanın
Authorization başlığında bearer token olarak gönderin:
curl https://peki.ai/api/agents/AGENT_ID/sessions \
-H "Authorization: Bearer psk_anahtariniz"
Anahtar hangi çalışma alanına ait olduğunu zaten bilir, bu yüzden çalışma alanı başlığı göndermeniz gerekmez. Ayrıntılar ve hatalar için bkz. Kimlik doğrulama.
Anahtar listesi
Listedeki her anahtar şunları gösterir:
| Alan | Örnek | Anlamı |
|---|---|---|
| Ad | CRM senkronu | Verdiğiniz ad. |
| Ön ek ve son dört | psk_3QeR8vXy…a1B2 | Anahtarları ayırt edebilmeniz için ilk 12 ve son 4 karakter. |
| Erişim | Okuma ve yazma | Erişim düzeyi. |
| Son kullanım | 5 dakika önce kullanıldı | Bir isteğin onu en son ne zaman kullandığı ya da hiç kullanılmadı. |
Kaldırabileceğiniz anahtarları bulmak için son kullanımı kullanın: oluşturduktan haftalar sonra hâlâ hiç kullanılmadı yazan bir anahtara muhtemelen ihtiyaç yoktur.
Anahtarı iptal edin
- Anahtarın yanındaki İptal et'e tıklayın.
- Onaylayın. Peki uyarır: "Bu anahtarı kullanan her şey hemen çalışmayı durdurur."
İptal edilen anahtar bir sonraki istekten itibaren reddedilir (401 Invalid API key). İptal geri alınamaz; bunun yerine yeni bir anahtar oluşturun.
Anahtarı yenileyin
Kesinti olmadan bir anahtarı değiştirmek için:
- Aynı erişimle yeni bir anahtar oluşturun.
- Yeni anahtarı sisteminize koyun ve yayına alın.
- Eski anahtarın son kullanım zamanının artık değişmediğini kontrol edin.
- Eski anahtarı iptal edin.
Anahtarları güvende tutun
- Anahtarları sunucunuzda tutun. Bir API anahtarını asla web sitenizin JavaScript'ine, mobil uygulama paketine ya da müşterinin indirebileceği herhangi bir şeye koymayın. Anahtarı olan herkes çalışma alanınız adına işlem yapabilir. Peki'yi backend'inizden çağırın, uygulamanız da backend'inizle konuşsun.
- Gizli olarak saklayın. Kaynak kodunuz yerine hosting'inizin gizli anahtar deposunu ya da ortam ayarlarını kullanın. Anahtarları git'e commit etmeyin.
- Her sisteme bir anahtar. Uygulamanız, CRM'iniz ve betikleriniz için ayrı anahtarlar, birini diğerlerini bozmadan iptal etmenizi sağlar; son kullanım da hangi sistemin aktif olduğunu söyler.
- Biri ayrılınca yenileyin. Anahtara erişimi olan biri ayrılırsa anahtarı yenileyin.
- En küçük şüphede iptal edin. Bir anahtar sızmış olabilirse hemen iptal edin ve yenisini oluşturun.
Anahtara parola gibi davranın. Destek taleplerine, ekran görüntülerine ya da sohbet mesajlarına yapıştırmayın.
Denetim
Anahtar oluşturma ve iptal etme, kimin yaptığıyla birlikte çalışma alanının denetim kaydına yazılır. Bir anahtarın yaptığı değişiklikler o anahtar tarafından yapılmış olarak kaydedilir. Bkz. Güvenlik modeli.