API istemcileri

Entegrasyonlar için API istemcisi oluşturun, gizli anahtarı alın, izinleri daraltın, anahtarı yenileyin veya istemciyi iptal edin.

API istemcileri ekranı, dış sistemlerin (entegrasyonların) platforma bir kişinin kullanıcı adı ve parolası yerine kendi kimlikleriyle bağlanabilmesi için istemci kaydı açtığınız yerdir. Her istemcinin bir client_id değeri, bir gizli anahtarı ve bir rolü vardır; entegrasyon yalnızca bu rolün izin verdiği işleri yapabilir. Ekranı genellikle entegrasyonları kuran ve bakımını yapan sistem yöneticileri kullanır.

Ekranın alt başlığında da yazdığı gibi: Anahtar her istekte doğrulanmaz: bir kez kısa ömürlü token’a çevrilir. Yani entegrasyon gizli anahtarını yalnızca oturum açarken kullanır; asıl istekler kısa süre geçerli bir erişim anahtarıyla yapılır.

Ekrana ulaşma

Menüde Ayarlar & Yetki › Erişim › API istemcileri yolunu izleyin. Menüde görmüyorsanız hesabınızın bu ekrana yetkisi yoktur.

Ekranın bölümleri

Ekran üstten alta şu parçalardan oluşur:

  1. Başlık — API istemcileri ve açıklama satırı.
  2. Gizli anahtar kutusu — Yalnızca yeni bir istemci oluşturduğunuzda ya da bir istemcide rotasyon yaptığınızda, sarı bir kutu içinde görünür (aşağıya bakın).
  3. İzin daraltma paneli — Bir satırda İzinleri daralt düğmesine bastığınızda açılır.
  4. Yeni istemci formu — Ad ve Rol alanları ile Oluştur düğmesi.
  5. İstemci listesi — Tanımlı tüm istemciler, iptal edilmiş olanlar dahil.
  6. Alt not — Eski anahtar 24 saat daha çalışır; istemci geçince kendiliğinden kapanır.

Bu ekranda filtre veya arama alanı yoktur; liste tek sayfada tüm istemcileri gösterir.

Liste

Kolon Anlamı
Ad İstemciye verdiğiniz ad. Altında durum rozetleri görünür: iptal edildi (kırmızı) istemcinin artık kullanılamadığını, rotasyon penceresi açık (sarı) yeni anahtar üretildiğini ve eski anahtarın hâlâ geçerli olduğu 24 saatlik geçiş süresinin sürdüğünü gösterir.
client_id Entegrasyonun kendini tanıttığı kimlik. Altında, gizli anahtarın tamamı yerine yalnızca tanımanıza yarayan kısa bir ipucu görünür; bununla entegrasyonda hangi anahtarın kullanıldığını karşılaştırabilirsiniz.
Roller İstemcinin sahip olduğu rollerin kodları rozet olarak. Altındaki satır izin kapsamını özetler: rolün tamamı (daraltma yok) ya da örneğin 5 izne daraltıldı.
Son kullanım İstemcinin en son ne zaman kullanıldığı (tarih ve saat). Hiç kullanılmamışsa hiç yazar.

Her satırın sonunda üç düğme bulunur: İzinleri daralt, Rotasyon ve İptal et. İptal edilmiş bir istemcide üç düğme de pasiftir.

Liste boşsa API istemcisi yok mesajı ve Entegrasyonlar için dar yetkili istemci oluşturun. ipucu görünür.

İşlemler

Yeni istemci oluşturma

Yeni bir entegrasyon kurarken ya da mevcut bir entegrasyona ayrı kimlik vermek istediğinizde kullanın.

  1. Ad alanına istemcinin ne için kullanılacağını anlatan bir ad yazın (örneğin "Pazaryeri sipariş aktarımı"). Bu ad yalnızca sizin tanımanız içindir.
  2. Rol listesinden istemcinin rolünü seçin. Seçenekler "Rol adı — rol kodu" biçimindedir. Entegrasyonun işini görecek en dar rolü seçin.
  3. Oluştur düğmesine basın. Ad ve rol seçilmeden düğme pasiftir.

Sonuç: İstemci listeye eklenir, Ad alanı temizlenir (seçtiğiniz Rol seçili kalır) ve ekranın üstünde sarı gizli anahtar kutusu açılır: Gizli anahtar bir daha gösterilmez. Şimdi kopyalayın:

  • Kopyala düğmesi anahtarı panoya kopyalar ve Kopyalandı. bildirimi gösterir.
  • Vazgeç düğmesi kutuyu kapatır.

Gizli anahtar yalnızca bu anda görünür; sistem onu okunamaz biçimde saklar ve daha sonra size tekrar gösteremez. Kutuyu kapatmadan veya sayfadan ayrılmadan önce anahtarı güvenli bir yere (entegrasyonun ayarına veya parola kasanıza) kaydedin. Anahtarı kaybederseniz tek çözüm Rotasyon ile yenisini üretmektir.

Entegrasyona client_id değerini (listede görünür) ve bu gizli anahtarı birlikte vermeniz gerekir.

Kutu aynı anda yalnızca bir anahtar gösterir. Kutu açıkken başka bir istemci oluşturur ya da bir istemcide Rotasyon yaparsanız, kutudaki anahtarın yerini yenisi alır ve önceki anahtar bir daha gösterilmez. Her anahtarı bir sonraki işleme geçmeden kopyalayın.

İzinleri daraltma

İstemcinin rolü gerekenden fazla izin içeriyorsa, rolü değiştirmeden bu istemci için izinleri kısmak amacıyla kullanın.

  1. İlgili satırda İzinleri daralt düğmesine basın.
  2. Listenin üstünde bir panel açılır; başında istemcinin adı ve client_id değeri yazar. Altındaki açıklama: Rolden gelen izinlerin hangileri kullanılabilir. Hiçbiri işaretli değilse rolün tamamı geçerlidir; buradan izin EKLENEMEZ, yalnızca kısılır.
  3. Listede yalnızca istemcinin rolünün taşıdığı izinler (izin kodlarıyla) görünür. İstemcinin kullanabilmesini istediğiniz izinleri işaretleyin.
  4. Kaydet düğmesine basın. Vazgeçmek için Vazgeç'e basın.

Sonuç: Kaydedildi. bildirimi görünür, panel kapanır ve listedeki Roller kolonunun alt satırı güncellenir ({sayı} izne daraltıldı ya da rolün tamamı).

Dikkat edilecekler:

  • Tüm işaretleri kaldırıp kaydederseniz daraltma kalkar ve istemci rolün tamamını kullanır. "Hiçbir izin yok" durumu bu yolla oluşturulamaz; istemciyi tamamen durdurmak için İptal et kullanın.
  • Bu panelden role olmayan bir izin eklenemez. İstemcinin daha fazla izne ihtiyacı varsa rolünü genişletmek gerekir (bkz. Roller ekranı).

Rotasyon (anahtarı yenileme)

Gizli anahtar kaybolduğunda, sızdığından şüphelendiğinizde ya da düzenli anahtar değişimi yaparken kullanın.

  1. İlgili satırda Rotasyon düğmesine basın. Onay sorulmaz.
  2. Ekranın üstünde yeni gizli anahtarı gösteren sarı kutu açılır. Kopyala ile alın ve entegrasyonun ayarına girin.

Sonuç: Satırda rotasyon penceresi açık rozeti görünür. Eski anahtar 24 saat daha çalışmaya devam eder; entegrasyon yeni anahtara geçtiğinde eski anahtar kendiliğinden kapanır. Böylece entegrasyonu kesintiye uğratmadan anahtarı değiştirebilirsiniz.

Anahtar sızdıysa ve eski anahtarın 24 saat daha çalışması kabul edilemezse, rotasyon yeterli değildir: istemciyi İptal et ile kapatıp yeni bir istemci oluşturun.

İstemciyi iptal etme

Entegrasyon artık kullanılmıyorsa veya istemcinin erişimi derhal kesilmeliyse kullanın.

  1. İlgili satırda İptal et düğmesine basın.
  2. Tarayıcı onay penceresinde Bu istemci iptal edilsin mi? Geri alınamaz. sorusunu onaylayın.

Sonuç: iptal edildi bildirimi görünür, satırda kırmızı iptal edildi rozeti çıkar ve satırdaki tüm düğmeler pasifleşir. İptal geri alınamaz; aynı entegrasyonu yeniden bağlamak için yeni bir istemci oluşturmanız gerekir. İptal edilen istemci listede kalmaya devam eder.

Durumlar

Durum (ekrandaki metin) Anlamı Sonraki adım
Rozet yok İstemci etkin, tek bir geçerli anahtarı var. —
rotasyon penceresi açık Yeni anahtar üretildi; eski anahtar geçiş süresince (24 saat) hâlâ geçerli. Entegrasyonu yeni anahtara geçirin.
iptal edildi İstemci kalıcı olarak kapatıldı; hiçbir anahtarı çalışmaz. Gerekirse yeni istemci oluşturun.

Sık karşılaşılan durumlar

  • Oluştur düğmesi basılmıyor. Hem Ad alanını doldurmanız hem de Rol seçmeniz gerekir.
  • Gizli anahtarı kopyalamadan kutuyu kapattım. Anahtar tekrar gösterilemez. Satırda Rotasyon yapıp yeni anahtarı kopyalayın; eski anahtar 24 saat daha çalıştığı için entegrasyon bu sürede kesilmez.
  • İzinleri daralt panelinde aradığım izin yok. Panel yalnızca istemcinin rolündeki izinleri listeler. Eksik izin için istemciye daha geniş bir rol gerekir.
  • Tüm izin işaretlerini kaldırdım ama istemci hâlâ her şeyi yapabiliyor. Hiçbir izin işaretli değilse rolün tamamı geçerlidir. Erişimi kesmek için İptal et kullanın.
  • Bir işlemde "Bir şeyler ters gitti" bildirimi aldım. İşlem sunucu tarafından reddedilmiştir (örneğin yetkiniz yoktur ya da servise ulaşılamamıştır); bildirimin açıklamasını kontrol edip tekrar deneyin.

İlgili ekranlar

  • Roller — İstemciye verilen rollerin izinlerini görmek ve düzenlemek için.
  • Kullanıcılar — İnsan kullanıcıların konsol erişimi için.
  • Entegrasyonlar — Entegrasyonların kullandığı API kullanıcıları ve örnek istekler için.