Platform entegrasyonu
Herkese Açık REST API ve Giden Webhook'lar
Ne yapar
- Mağazanızın verisini kendi alan adınız üzerinde sürümlenmiş bir REST API ile, token tabanlı kimlik doğrulama ve kapsam bazlı izinlerle sunar.
- order.paid, product.updated, stock.low gibi mağaza olaylarına dış adresleri abone etmenizi sağlar; gönderimler HMAC ile imzalanır.
- Üçüncü taraf entegrasyon platformlarını ve kendi betiklerinizi özel bir modül olmadan bağlar.
Her Kambloo mağazasının kendi API yüzeyi vardır. Herkese açık REST API, geliştiricilerinizin, ajansınızın ve üçüncü taraf araçların resmî bir modülü beklemeden mağaza verisini okumasını ve yazmasını sağlar. Giden webhook'lar olayları gerçekleştikçe sistemlerinize iletir. İkisi de dâhildir; ödenecek bir sağlayıcı yoktur.
Kambloo ile nasıl çalışır
Kimlik doğrulama, yönetim panelinden verilen kişisel erişim token'larıyla yapılır. Her token products:read ya da orders:write gibi kapsamlar taşır; böylece bir raporlama betiği veriyi değiştiremez. Token'lar mağazanızın kendi alan adında çalışır; örneğin https://magazaniz.com/api/v1/orders ve Kambloo mağazayı alan adından çözer.
Kaynaklar ürünler, ürün varyantları, siparişler, müşteriler ve stoktur; her biri oluşturma, okuma, güncelleme, silme ve listeleme işlemlerine sahiptir. Listeler imleç sayfalaması ve yaygın alanlar için bir filtre söz dizimi kullanır. API bir OpenAPI tanımıyla belgelenir. Sürüm adreste /v1 olarak taşınır ve kırıcı bir değişiklik, eskisi en az 12 ay desteklenmek üzere yeni bir sürüm demektir.
Hız sınırı token başına dakikada 120 istektir ve Redis'te sayılır. Aşıldığında Retry-After başlığıyla 429 döner. Sentos, Prapazar ve Sopyo gibi entegrasyon platformlarının bağlandığı API de aynı herkese açık API'dir.
Giden webhook'lar tabloyu tamamlar. Bir aboneliği hedef adres, bir olay kümesi ve bir gizli anahtarla tanımlarsınız. Olaylar sipariş yaşam döngüsünü (oluşturuldu, ödendi, kargolandı, iptal edildi), katalog değişikliklerini (ürün oluşturuldu, güncellendi, silindi), yeni müşterileri ve düşük stoğu kapsar. Her gönderim, verinin HMAC'ini taşıyan bir X-Kambloo-Signature başlığıyla gönderilen bir JSON POST'tur; adresiniz bunu doğrular. 2xx dışındaki yanıtlar üstel geri çekilmeyle beş yeniden deneme tetikler; üç gün üst üste başarısız olan bir adres otomatik olarak devre dışı bırakılır ve size bildirilir. Panel, istek ve yanıt özetleriyle son 100 gönderimi ve bir yeniden gönderme düğmesi gösterir.
Hedef adresler, özel ağ adreslerini engelleyen Kambloo'nun güvenli HTTP katmanından geçer.
Gerekenler
- Yönetim panelinde oluşturulmuş, doğru kapsamlara sahip bir API token'ı.
- Webhook'lar için: imzayı doğrulayan ve hızlıca 2xx dönen bir HTTPS adresi.
- Token'lar ona bağlı olduğu için yayımlanmış bir mağaza alan adı.
Kurulum adımları
Kısa sürüm. Mağaza yönetim panelinizdeki ekranlar aynı sırayı izler.
- Ayarlar > Geliştiriciler > API Token'ları bölümünü açın ve ihtiyacınız olan kapsamlarla, örneğin products:read, bir token oluşturun.
- https://magazaniz.com/api/v1/products adresini token'ı bearer başlığı olarak vererek çağırın.
- Bir webhook aboneliği ekleyin: hedef adres, olaylar ve bir gizli anahtar.
- Bir veriye güvenmeden önce kendi tarafınızda X-Kambloo-Signature başlığını doğrulayın.
Herkese Açık REST API ve Giden Webhook'lar hakkında sorular
API hangi kaynakları kapsıyor?
Ürünler, ürün varyantları, siparişler, müşteriler ve stok; token'ın kapsamlarının izin verdiği yerlerde oluşturma, okuma, güncelleme ve silme ile. API bir OpenAPI tanımıyla belgelenir.
Hız sınırları nedir?
Token başına dakikada 120 istek; Redis üzerinde uygulanır. Sınırın üstünde Retry-After başlığıyla 429 alırsınız. Daha büyük hosting planlarıyla daha yüksek sınırlar ayarlanabilir.
Bir API sürümü ne kadar destekleniyor?
Kırıcı değişiklikler adreste yeni bir sürüm olarak çıkar ve önceki sürüm en az 12 ay kullanılabilir kalır.