API Ayarları

106 görüntülenme Markdown

Harici entegrasyonlar için API anahtarı verin, her birini yalnızca ihtiyaç duyduğu uç noktalarla sınırlayın, API'nin aldığı her isteği inceleyin.

Ekrana Erişim

Ayarlar › Genel Ayarlar'ı açın, ardından API sekmesini seçin: {admin}/settings?general=api

Ekranda Neler Var

Sekme en fazla üç alt sekme taşır.

Admin API

Bu ekrandan verilen anahtarlar. Tam yetkili bir yönetici tüm personelin anahtarlarını ve kime ait olduklarını görür. Diğer yöneticiler kendi anahtarlarını görür. Her satır izin özetini, izin verilen IP'leri ve son erişimi listeler; yanında Detaylar ve Sil aksiyonları bulunur. Tablonun üstünde toplu Seçilenlere uygula listesi ve API Kimlik Bilgisi Oluştur butonu yer alır.

Client API

Bu liste değiştirilemez ve yalnızca tam yetkili bir yöneticiye görünür; bir müşteri kendi hesabından anahtar oluşturana kadar liste boş kalır. Görünürlük içindir, yönetimi müşteri panelinden müşteriye aittir.

Kayıtlar

API'nin aldığı her istek; çağıran, yöntem ve uç nokta, tarih ve IP adresiyle birlikte listelenir. Bir satıra tıklamak isteğin tam başlığını, gövdesini ve yanıtını açar. Tümünü Sil butonu tüm kaydı temizler.

API Aktivasyonu

API Kimlik Bilgisi Oluştur'un yanındaki dişli butonu, iki API'nin açık olup olmadığını belirleyen pencereyi açar. Admin API personel anahtarlarını, Client API müşterilerin kendi oluşturduğu anahtarları kapsar. Client API kapalı gelir; açtığınızda erişimi tüm müşterilere ya da seçtiğiniz müşterilere verirsiniz.

Aynı pencerede Erişilebilir Uçlar bölümü, müşterilerin anahtarlarına hangi uç noktaları verebileceğini belirler. Tüm uçlar açık gelir; Seçili Uçlar'a geçtiğinizde müşteriler yalnızca işaretlediğiniz uçları görür ve seçebilir.

Alanlar

Kimlik Bilgisi Alanları

AdZorunludur.
İzin verilen IP adresleriİsteğe bağlı, her satıra bir adres. Boş bırakılırsa her adrese izin verilir.
İstek Limiti (dakikada)İsteğe bağlı. Boş bırakılır veya 0 girilirse sistem varsayılanı kullanılır.

Aktivasyon Alanları

Admin APIAçık gelir. Kapatıldığında personel anahtarları hiçbir isteği yanıtlamaz.
Client APIKapalı gelir. Kapalıyken müşteriler panellerinde API sayfasını görmez.
ErişimTüm Müşteriler ya da Seçili Müşteriler. Yalnızca Client API açıkken görünür.
Erişimi Olan MüşterilerSeçili Müşteriler işaretliyse zorunludur; en az bir müşteri seçilmelidir.
Erişilebilir UçlarTüm Uçlar ya da Seçili Uçlar. Yalnızca Client API açıkken görünür.
Uç listesiSeçili Uçlar işaretliyse zorunludur; en az bir uç işaretlenmelidir.

İzinler

Solda kategori listesi, sağda o kategorinin uç noktaları, her birinin kendi onay kutusuyla. Tam erişim ver anahtarın erişebileceği tüm uç noktaları işaretler. Bir arama kutusu ve kategori başına "tümünü seç" bağlantısı listeyi daraltır. En az bir izin seçilmesi zorunludur.

İşlemler

Harici Bir Araç İçin API Anahtarı Oluşturma

  1. API Kimlik Bilgisi Oluştur'a tıklayın, bir ad girin.
  2. İsteğe bağlı olarak İzin verilen IP adresleri'ni kısıtlayın ve bir İstek Limiti belirleyin.
  3. Yalnızca aracın ihtiyaç duyduğu izinleri, ya da Tam erişim ver'i işaretleyip kaydedin.
  4. Yalnızca bir kez gösterilen anahtarı kopyalayın. Pencereyi kapattıktan sonra tekrar gösterilmez.

Client API'yi Belirli Müşterilere Açma

  1. Dişli butonuna tıklayın ve Client API'yi açın.
  2. Seçili Müşteriler'i işaretleyin.
  3. Erişimi Olan Müşteriler kutusunda müşteri arayıp seçin, ardından kaydedin.
  4. Seçtiğiniz müşteriler kendi panellerinde API sayfasını görür ve anahtar oluşturabilir.

Müşterilerin Erişebileceği Uçları Sınırlama

  1. Dişli butonuna tıklayın; Client API açık olmalıdır.
  2. Erişilebilir Uçlar altında Seçili Uçlar'ı işaretleyin.
  3. Açılan listede kategori seçip uçları işaretleyin. Arama kutusu ve kategori başına "tümünü seç" listeyi daraltır.
  4. Kaydedin. Müşteriler kendi anahtar penceresinde yalnızca bu uçları görür; mevcut anahtarlar kalan uçları bir sonraki istekte kaybeder.

Bir Anahtarı Sınırlama veya İptal Etme

  1. İzinlerini, IP'lerini veya limitini değiştirmek için anahtarın Detaylar aksiyonunu açıp kaydedin.
  2. Erişimi tamamen kaldırmak için silin, tek başına ya da Seçilenlere uygula ile birkaçını birden.
  3. Anahtar hemen çalışmaz hale gelir.

Dikkat Edilecekler

Giriş paketlerinde bu ekran değiştirilemez

Lisans paketiniz API'yi kapsamıyorsa sekme görünür kalır ama kontrolleri devre dışıdır ve üstte bir uyarı çıkar. Müşteri panelinde de API Kimlik Bilgileri sayfası ve menü bağlantısı görünmez. Erişim, paket yükseltmesiyle geri gelir.

Anahtar yalnızca bir kez gösterilir

Oluşturma penceresini kapattıktan sonra geriye yalnızca maskeli bir önek kalır. Anahtar kaybolursa yenisini oluşturun.

Bir anahtar kendi yetkilerinizi asla aşamaz

Tam erişim ver bile hesabınızın izin verdiğiyle sınırlıdır. İşaretlenen izinlerin hiçbiri kendi yetkilerinizin kapsamında değilse kayıt reddedilir.

Diğer personelin anahtarları gizli kalır

Sahibi sütunu ve Client API sekmesi tam yetkili yöneticiler dışında görünmez.

Erişimi kapatmak anahtarları silmez

Client API'yi kapatmak ya da bir müşteriyi listeden çıkarmak, o anahtarları bir sonraki istekte durdurur. Anahtarlar saklanır ve erişimi geri verdiğinizde yeniden çalışır.

Gerekli Yetkiler

Ayarlar › Genel Ayarlar'ı açmak SETTINGS_INFORMATIONS_CONFIGURE ister. API sekmesini görüntülemek ve yönetmek ayrıca SETTINGS_API_CREDENTIALS gerektirir.

Faydalı oldu mu?

Geri bildiriminiz için teşekkürler!

Hâlâ Yardıma mı İhtiyacınız Var?

Yukarıda bulamadığınız her şey için destek ekibimiz her zaman yanınızda.