Kimlik Doğrulama
Stokzone Web Servis API'si, her istekte gönderilen bir API anahtarı (X-API-Key) ile kimlik doğrular. Anahtarlar yalnızca kendilerine atanmış yetkilere (scope) sahip uçlara erişebilir.
X-API-Key başlığı
API anahtarınızı her isteğe X-API-Key başlığı olarak ekleyin. Anahtar gövdede veya sorgu parametresinde gönderilmez.
HTTP
X-API-Key: sk_live_xxxxxxxxxxxxYetki (scope) kataloğu
Her anahtara yalnızca ihtiyaç duyduğu yetkileri verin (en az ayrıcalık ilkesi). Bir uç, gerekli scope yoksa 403 döndürür.
| Yetki | Açıklama |
|---|---|
products:read | Ürünleri ve varyantları listele ve oku |
products:write | Ürün kartı oluştur ve güncelle |
orders:read | Siparişleri listele ve oku |
orders:write | Sipariş durumlarını güncelle |
inventory:write | Stok adetlerini güncelle |
prices:write | Satış fiyatlarını güncelle |
returns:read | İade ve talep kayıtlarını oku |
returns:write | İade ve talepleri onayla/güncelle |
invoices:read | Fatura kayıtlarını oku |
questions:read | Müşteri sorularını oku |
questions:write | Müşteri sorularını yanıtla |
customers:read | Müşteri kartlarını oku |
categories:read | Kategori ağacını oku |
brands:read | Marka listesini oku |
buybox:read | Buybox durumunu oku |
shipping:read | Kargo ve gönderi bilgilerini oku |
shipping:write | Kargo gönderisi oluştur ve güncelle |
reports:read | Satış ve performans raporlarını oku |
webhooks:manage | Giden webhook aboneliklerini yönet |
IP kısıtlama
Her API anahtarı için isteğe bağlı bir IP beyaz listesi tanımlayabilirsiniz. Liste tanımlıysa yalnızca o IP adreslerinden gelen istekler kabul edilir; diğerleri 403 alır.
Yetki hataları
401 Unauthorized — API anahtarı eksik, geçersiz veya iptal edilmiş.
401
{
"detail": "Geçersiz veya eksik API anahtarı"
}403 Forbidden — Anahtar geçerli ancak bu uç için gerekli yetkiye (scope) sahip değil.
403
{
"detail": "Bu işlem için 'orders:read' yetkisi gerekli"
}