Public API’ler

Public API’ye genel bakış: neler yapabildiği, kimlik doğrulama ve istek sınırları.

1. API kullanım kapsamı

a. API ile desteklenen özellikler

Public API, Wholesale uygulamasının ana özellikleriyle etkileşim kurmanıza olanak tanır:

Temel özellikler: Wholesale Pricing, Volume Pricing, Kayıt formu, Quick Order Form, Quick Buy Collection, Quick Buy Variant
Eklenti özellikleri: Order Limit, Shipping Rate, Extra Fee, Payment Term (Yakında)

b. Desteklenen yöntemler

API, aşağıdaki HTTP yöntemleriyle tam CRUD işlemlerini destekler:

GET – Veri alma
POST – Yeni veri oluşturma
PUT – Mevcut veriyi güncelleme
DELETE – Veriyi kaldırma

API anahtarlarına şu izin düzeyleri verilebilir: Read Only/Write Only, Read & Write

Desteklenen işlemler: Get list - Get item - Create item - Update item - Delete item

c. Desteklenen Shopify planları:

Wholesale uygulamasının Public API’si, aşağıdaki koşulları karşılayan Shopify mağazalarında kullanılabilir:

Canlı mağaza (Production store) olmalıdır (geliştirme veya test mağazaları için geçerli değildir)
Gold planına abone olunmalıdır

2. Kimlik doğrulama

Tüm API istekleri, işlenmeden önce doğru şekilde kimlik doğrulamasından geçmelidir.

a. Zorunlu parametreler

Her API isteği aşağıdaki zorunlu parametreleri içermelidir:

Parametre	Açıklama
`shop`	Shopify mağaza alan adı (ör. mystore.myshopify.com)
`api_key`	Wholesale uygulamasından oluşturulan API anahtarı

Bu parametrelerden biri eksikse istek reddedilir.

b. API anahtarı yönetimi

API anahtarları doğrudan Wholesale uygulamasının yönetim arayüzünde oluşturulur ve yönetilir.
Mağaza sahipleri her API anahtarı için belirli izinler tanımlayabilir: Read only/Write only, Read & Write

3. API yapısı ve yanıt biçimi

a. API uç noktası

Tüm API istekleri aşağıdaki temel URL’yi kullanmalıdır:

https://wholesale.samita.io/v1/

b. Özelliğe özgü uç noktalar

Her özellik grubunun kendi uç noktası vardır. Örneğin:

Wholesale özelliği:

https://wholesale.samita.io/v1/wholesale/

Volume Pricing özelliği:
```
https://wholesale.samita.io/v1/volume/
```

(Gerçek uç noktalar, ilgili işleve göre değişebilir.)

c. Desteklenen sorgu parametreleri

API, birkaç ortak sorgu parametresini destekler:

Parametre	Açıklama
`status`	Kayıtların durumu
`page`	Sayfalama için sayfa numarası
`limit`	Sayfa başına kayıt sayısı
`sort`	Sıralama ölçütü
`query`	Arama veya filtre koşulu

Örnek istek:

GET /wholesale?page=1&limit=20&sort=created_at

4. Yanıt kodları

Her API isteği aşağıdaki durum kodlarından birini döndürür:

a. Yaygın hata yanıtları

401 – Yetkisiz

Olası nedenler:

Mağaza URL’si eksik
API anahtarı eksik
Mağaza URL’si geçersiz
API anahtarı geçersiz
API anahtarı mağazayla eşleşmiyor

403 – Bu işlem için yetki yok

API anahtarının istenen işlemi gerçekleştirme izni yok
View / Create / Update / Delete için izinler yetersiz

429 – Çok fazla istek

İstek sınırı aşıldı
API çağrı sıklığı izin verilen sınırı aşıyor

b. Başarılı yanıt

200 – Başarılı

İstek geçerli
API işlemi başarıyla gerçekleştirildi
Veriler doğru biçimde döndürüldü

5. İstek sınırı

Sistem performansını ve kararlılığını korumak için API kullanımı bir günlük istek sınırına tabidir. Artık istek başına/kısa aralıklı bir kısıtlama yoktur; planınızın günlük kotası içinde kaldığınız sürece API’yi istediğiniz sıklıkta çağırabilirsiniz.

Günlük sınır, mağazanın fiyatlandırma planına bağlıdır:

Plan	Günlük istek sınırı
Free	Günde 5 istek
Starter	Günde 50 istek
Growth	Günde 250 istek
Enterprise	Günde 500 istek

Günlük sayaç her gün gece yarısı (sunucu saatiyle) sıfırlanır.

Günlük sınır aşılırsa sistem şunu döndürür:

429 – Too Many Requests

{
  "message": "Daily request limit exceeded (X requests/day)."
}

Bu sayfa yardımcı oldu mu?