API Anahtarı Oluşturma

API anahtarını mağazanın yöneticisi, Hızlı Sanal Market yönetim panelinden oluşturur. Bu sayfadaki adımlar yönetici hesabıyla yapılır. Anahtarı kullanacak geliştiricinin panele girmesi gerekmez.

1. API erişimini açın

API erişimi Profesyonel, Kurumsal ve Premium paketlerde vardır. Bu paketlerde sol menüde API Anahtarları görünür.

Menüde API Anahtarları yoksa Pazaryeri sayfasında arama kutusuna API yazın. Çıkan API, Webhook & Bayi Servisi modülünü Yükle düğmesiyle kurun. Modül ücretsizdir ve en az Profesyonel paket ister.

Pazaryeri sayfasında API, Webhook & Bayi Servisi modülü

2. API Anahtarları sayfasını açın

Sol menüden API Anahtarları sayfasına girin. Listede mağazanın bütün anahtarları görünür:

  • Ad: Anahtarın hangi entegrasyona ait olduğunu anlatan isim.
  • Anahtar: Anahtarın yalnızca ilk karakterleri gösterilir. Anahtarın tamamı sonradan görüntülenemez.
  • İzinler: Anahtarın kullanabileceği uçlar.
  • Son Kullanım: Anahtarla yapılan son isteğin zamanı. Kullanılmayan anahtarları buradan fark edebilirsiniz.
  • Durum: Aktif ya da İptal.

API Anahtarları listesi

3. Yeni anahtar oluşturun

Yeni Anahtar düğmesine basın. Anahtara entegrasyonu anlatan bir ad verin, örneğin "Depo yazılımı (WMS)". Sonra yalnızca gereken izinleri işaretleyin:

İzin Ne sağlar?
products:read Ürünleri listeleme ve tek ürün okuma
products:write Ürün açma ve ürün bilgilerini güncelleme
stock:write Stok güncelleme ve toplu stok/fiyat güncelleme
orders:read Siparişleri listeleme ve tek sipariş okuma
orders:write Sipariş durumunu güncelleme (hazırlanıyor, kargoda, teslim, iptal, iade)
categories:read Kategori ve marka listeleri
categories:write Kategori ve marka açma
customers:read İleride açılacak müşteri uçları için ayrılmıştır. Şu an bu izinle çağrılan bir uç yoktur.

Örnek: Siparişleri çekip stok gönderen bir depo yazılımı için products:read, stock:write, orders:read ve orders:write yeterlidir.

Yeni API anahtarı formu

4. Anahtarı kopyalayıp saklayın

Oluştur düğmesine bastığınızda anahtar sarı bir kutuda gösterilir. Kopyala ile alın ve güvenli bir yerde saklayın.

Anahtarın tamamı yalnızca bu ekranda, bir kez gösterilir. Sayfadan çıktıktan sonra tekrar görüntülenemez. Anahtarı kaybederseniz yeni bir anahtar oluşturun ve eskisini iptal edin.

Oluşturulan API anahtarı

Anahtar hm_sk_ ile başlar ve toplam 46 karakterdir. Bu anahtar entegrasyona mağazanın verilerine erişim yetkisi verir. Parola gibi saklayın:

  • Anahtarı tarayıcıda çalışan koda, mobil uygulamaya ya da herkese açık bir kod deposuna koymayın. Yalnızca sunucu tarafında kullanın.
  • Anahtarı ortam değişkeninde ya da bir gizli bilgi kasasında tutun.
  • Her entegrasyona ayrı bir anahtar verin. Böylece bir entegrasyonu kapatmak için yalnız onun anahtarını iptal etmeniz yeter.

Anahtarı iptal etme

Listede anahtarın satırındaki çöp kutusu simgesine basın ve onaylayın. Anahtarın durumu İptal olur. Bu anahtarla gelen istekler hemen 401 ve KEY_INACTIVE koduyla reddedilir. İptal geri alınamaz. Gerekirse yeni bir anahtar oluşturun.

Sınırlar

  • Bir mağazada aynı anda en fazla 10 aktif anahtar bulunabilir.
  • Her anahtarın istek sınırı dakikada 60, günde 10.000 istektir. Daha yüksek bir sınıra ihtiyacınız varsa bilgi@teybilisim.com adresine yazın.