Kimlik doğrulama
Hesap API anahtarları, tam ve özel erişim ve birini nerede oluşturacağınız.
CPI'ya yapılan her çağrı bir API anahtarı taşır. Ayrı bir istemci kimliği, OAuth el sıkışması ya da hesaplanacak bir imza yoktur; istekle birlikte gönderilen tek bir anahtar vardır.
Anahtar oluşturma
Anahtarlar panelde, hesap menüsünün Geliştiriciler ekranında, API anahtarları sekmesinde bulunur.
Bir projenin kendi API sekmesi aynı türde, zaten o projeye kapsamlanmış bir anahtar oluşturur; böylece
app_id değerini elle yazmazsınız. Etkileşimli API başvurusu sanal alanı da sizin için
anında bir tane oluşturabilir; böylece kendi koduna bir şey bağlamadan önce bir yöntemi deneyebilirsiniz.
Bir API anahtarı oluşturmak kimlik doğrulaması gerektirir; Xuda'nın bir telefon numarası, bir posta kutusu veya taşınabilir bir IP vermeden önce istediği 2. düzey denetimin aynısı. Hiçbir şeyi doğrulanmamış bir hesap, anahtar formu açılmadan önce doğrulama yapması için bir istem görür.
Kapsam: anahtarın hangi hesap olarak işlem yaptığı
Bir anahtar üç kapsamdan biriyle üretilir ve her zaman üretildiği hesap veya uygulama adına işlem yapar:
- Hesap: doğrudan hesabınız adına işlem yapar; oturum açılmış bir panel oturumundan yapacağınız gibi. Düz bir hesap anahtarının ulaşabildiği her yönteme ulaşır.
- Uygulama: bir projenin kendi API sekmesinden üretilir ve o projenin
app_iddeğerine sabitlenir. - Tam Yığın VPS: bir Tam Yığın VPS hazırladığınızda otomatik verilir ve oluşturma sırasında seçilen yetenek gruplarına kapsamlanır. Neyi kapsadığı için Tam Yığın VPS sayfasına bakın.
Erişim: tam veya özel
Her anahtar ayrıca herkese açık yüzeyin ne kadarına ulaşabileceğini seçer:
- Tam erişim: hesabın API üzerinden yapabildiği her şey; anahtar oluşturulduktan sonra eklenen yöntemler
dahil. Özel yöntemler her koşulda hariç kalır:
private: truekatı bir duvardır, her çağrıda denetlenir ve tam erişimin geçersiz kılabileceği bir varsayılan değildir. - Özel erişim: anahtar formunda yöntemleri işaretleyerek oluşturduğunuz açık bir izin listesi; mikro
hizmete göre gruplanır ve her yöntemin alanları satır içinde gösterilir. Sonradan eklenen bir yöntem, geri
dönüp ona izin verene kadar dahil edilmez.
clearancedeğeripublicolan bir yönteme, hiçbir şey işaretlenmemiş özel bir anahtarla bile her zaman ulaşılabilir; çünkü herkese açık bir yöntem oturum ve izin listesi kaydı gerektirmez.
API anahtarlarını oluşturan, güncelleyen ve listeleyen yöntemlere (create_account_api_key,
get_app_api_keys ve api_module'ün geri kalanı) bir API anahtarıyla hiçbir zaman ulaşılamaz; bu bilerek
böyledir: bir kimlik bilgisi, kimliğini doğruladığı hesap için kimlik bilgisi üretemez veya düzenleyemez.
Anahtarları panelden veya oturum açılmış bir oturumdan yönetin.
Anahtarı gönderme
Düz REST üzerinden anahtar, api_key adlı bir istek parametresidir: POST ile JSON gövdesindeki bir alan,
GET ile bir sorgu dizesi parametresi. İki biçim için Bir yöntemi çağırma
sayfasına bakın.
MCP üzerinden aynı anahtar bunun yerine bir Authorization: Bearer başlığına konur; bir api_key alanı
yoktur. Bkz. MCP.
Bir API anahtarı taşıyıcı bir kimlik bilgisidir: ona sahip olan hesabınız adına işlem yapar. Hiçbir zaman istemci tarafı koda koymayın, depoya göndermeyin ya da paylaşılan bir ekran görüntüsüne yapıştırmayın. Bu yerlerden birinde ortaya çıkarsa anahtarı hemen değiştirin; değiştirme adı ve erişim modunu korur ve eski değeri aynı adımda geri alır.