API anahtarları

Ayarlar içindeki API Anahtarları bölümü (/settings/api-keys), storefront'unuzun bu işletmenin API'sini kullanmak için ihtiyaç duyduğu anahtarları oluşturduğunuz yerdir. Anahtarlar o an seçili olan işletmeye bağlıdır; bu yüzden anahtar oluşturmadan önce doğru işletmeye geçin. Oturum açmış her ekip üyesi anahtar oluşturabilir ve iptal edebilir.

Bir storefront'un anahtarı gerçekte nasıl kullandığını (başlıklar, kapsamlar, hatalar) API referansındaki Kimlik doğrulama sayfasında bulabilirsiniz. Bölüm ayrıca yeni sekmede açılan tam API belgeleri bağlantısını içerir.

Anahtar oluşturun#

1. Ayarlar sayfasını açın ve API Anahtarları bölümünü seçin.
2. Anahtar oluştur kutusunda bir Anahtar adı girin (örneğin storefront).
3. En az bir kapsam seçeneğini açın. Hem bir ad hem de bir kapsam belirleyene kadar Oluştur düğmesi devre dışı kalır; yanındaki ipucu hangisinin eksik olduğunu söyler.
4. Oluştur düğmesine tıklayın.

Kapsamlar#

Kapsamlar etkin modüllerinizden gelir; bu yüzden liste işletmeden işletmeye değişir. Her zaman tenant:read kapsamını, ayrıca etkin her modül için bir read ve bir write kapsamını görürsünüz, örneğin commerce:read ve commerce:write. İhtiyaç duyduğunuz kapsam listede yoksa, platform yöneticisinden ilgili modülü etkinleştirmesini isteyin.

İşe yarayan en dar kümeyi seçin: yalnızca ürün gösteren bir storefront'un write değil, read kapsamlarına ihtiyacı vardır.

Token'ı kopyalayın: yalnızca bir kez gösterilir#

Anahtar oluşturulduktan hemen sonra, anahtarın düz metin token'ı Bu token'ı şimdi kopyalayın. Yalnızca bir kez gösterilir. başlıklı vurgulu bir kutuda görünür. Token'ı görebileceğiniz tek an budur:

• Token'ı kopyala düğmesine tıklayın (etiket kısa süreliğine Kopyalandı olur) ve token'ı storefront'unuzun gizli anahtar deposunda saklayın.
• Sayfadan ayrıldığınızda veya sayfayı yenilediğinizde token bir daha asla görüntülenemez.
• Kaybederseniz kurtarma yolu yoktur: anahtarı iptal edip yenisini oluşturun.

Anahtarlarınızı gözden geçirin#

Her anahtar satırı adı, kapsam listesini, oluşturulma tarihini ve bir tarihle birlikte Son kullanım bilgisini, ya da anahtarla henüz hiçbir API çağrısı yapılmadıysa Hiç kullanılmadı ifadesini gösterir. Eski bir anahtarda Hiç kullanılmadı görüyorsanız, bu anahtarın iptal edilebileceğine dair iyi bir işarettir.

Bir anahtarı iptal edin#

1. Anahtarın satırındaki İptal et düğmesine tıklayın.
2. Bir Anahtarı iptal et iletişim kutusu onay ister: bu anahtarı kullanan storefront'lar API erişimini hemen kaybeder.
3. Onaylamak için İptal et düğmesine tıklayın.

İptal işlemi anında gerçekleşir ve kalıcıdır. Yayında olan bir storefront anahtarı hâlâ kullanıyorsa, önce yedek bir anahtar oluşturun, onu devreye alın, sonra eski anahtarı iptal edin.