xShopum · Geliştirici Entegrasyonu

API, Sipariş ve Webhook entegrasyonuna hızlı başlangıç

Ürün kataloğunu API ile senkronize edin, yalnız değişen ürünleri alın, kendi siparişlerinizi kargo ve fatura bilgileriyle sorgulayın ve stok bildirimlerini webhook ile sisteminize anlık taşıyın.

Base URLhttps://api.xshopumbayi.com/v1
Tam API dokümantasyonu ↗Hızlı başlangıçOpenAPI 3.1
Ürün APITam katalog + değişikliklerGET /products ile ilk senkronizasyon; /products/changes?hours=N ile delta senkronizasyon.
Sipariş APISipariş + kargo + faturaBayinin kendi siparişleri tek yanıtta kargo ve fatura özetiyle birlikte gelir.
WebhookStok bildirimiÜrün stoktan çıktığında veya tekrar stoklandığında sisteminize push bildirimi gönderilir.
GüvenlikSunucudan sunucuyaClient ID / Client Secret ile API erişimi; webhook endpoint'i için ayrı API Key veya Basic Auth.

Hızlı başlangıç

  1. Hesabım → Entegrasyon ekranından Client ID ve Client Secret oluşturun.
  2. GET /products?limit=100 ile ilk kataloğu alın ve nextUrl bitene kadar sayfaları tamamlayın.
  3. Sonraki senkronizasyonlarda GET /products/changes?hours=5 gibi yalnız değişen kayıtları alın.
  4. GET /orders ile en fazla 31 günlük aralıkta kendi siparişlerinizi sorgulayın.
  5. Webhook kullanacaksanız POST /webhooks ile HTTPS endpoint'inizi API üzerinden kaydedin.

Temel endpointler

YöntemYolNe yaparReferans
GET/productsTüm bayi ürün kataloğunu sayfalı getirirürün
GET/products/changes?hours=5Son belirtilen saat içinde değişen ürünleri getirirürün
GET/account/open-accountVadeli/Açık Hesap limit, borç, vade ve kullanılabilir limit özetini getirirhesap
GET/ordersBayinin kendi siparişlerini kargo ve fatura özetiyle listelersipariş
POST/ordersVadeli/Açık Hesap ile gerçek WooCommerce dropshipping siparişi oluşturursipariş
GET/orders/{id}Bayinin tek sipariş detayını getirirsipariş
GET/orders/{id}/invoiceSiparişe ait fatura bilgisini getirirsipariş
POST/webhooksWebhook adresi oluşturur, event aboneliklerini kaydeder ve doğrularwebhook
GET/webhooksKayıtlı webhook ve bağlantı durumunu getirirwebhook
PUT/webhooks/{id}Webhook adresini, event aboneliklerini veya endpoint yetkilendirmesini güncellerwebhook
PUT/webhooks/{id}/activateWebhook bağlantısını yeniden aktifleştirirwebhook
PUT/webhooks/{id}/deactivateWebhook bağlantısını pasife alırwebhook
DELETE/webhooks/{id}Webhook kaydını silerwebhook

İstek sınırları

Ürün 120/dkSipariş 60/dkWebhook yönetimi 20/dkGlobal 240/dk
Bu sayfa hızlı tanıtım içindir. Teknik sözleşme, parametreler, hata kodları ve güncel örnekler için canonical geliştirici dokümantasyonu esas alınır.
xShopum · Webhook Entegrasyon Rehberi

İhtiyacınız olan webhook bildirimlerini anlık alın

Webhook ile stok, sipariş durumu ve fatura hazır olaylarından yalnız ihtiyacınız olanları seçebilirsiniz. URL, event abonelikleri, yetkilendirme, aktifleştirme ve silme işlemleri Entegrasyon API üzerinden yönetilir.

APIhttps://api.xshopumbayi.com/v1
Tam webhook referansı ↗Tüm API dokümantasyonu
EventsSeçilebilir bildirimlerStok, sipariş durumu ve fatura hazır eventlerinden birini, birkaçını veya tamamını seçebilirsiniz.
Endpoint AuthAPI Key veya Basic AuthWebhook alıcı adresinizi kendi seçtiğiniz endpoint doğrulamasıyla koruyabilirsiniz.
Health60 dakikaBu süre boyunca başarılı 2xx alınamazsa webhook otomatik pasife alınır.
Retry5 dakikada birİlk bağlantı sorununda e-posta uyarısı gönderilir; bağlantı düzelirse health durumu sıfırlanır.

Webhook'u API ile yönetin

YöntemYolNe yaparReferans
POST/webhooksWebhook adresi oluşturur, event aboneliklerini kaydeder ve doğrularwebhook
GET/webhooksKayıtlı webhook ve bağlantı durumunu getirirwebhook
PUT/webhooks/{id}Webhook adresini, event aboneliklerini veya endpoint yetkilendirmesini güncellerwebhook
PUT/webhooks/{id}/activateWebhook bağlantısını yeniden aktifleştirirwebhook
PUT/webhooks/{id}/deactivateWebhook bağlantısını pasife alırwebhook
DELETE/webhooks/{id}Webhook kaydını silerwebhook

Webhook oluşturma örneği

API_KEY kullanırsanız belirlediğiniz anahtar xShopum'un webhook POST isteğinde x-api-key başlığıyla gönderilir.

POST /webhooks Content-Type: application/json { "url": "https://example.com/webhooks/xshopum", "events": ["product.stock.changed", "order.invoice.ready"], "authenticationType": "API_KEY", "apiKey": "endpoint-secret-key" }

Alternatif olarak BASIC_AUTHENTICATION seçip username ve password gönderebilirsiniz.

Event abonelikleri

PUT /webhooks/{id} ile yalnız events dizisini göndererek seçimleri sonradan değiştirebilirsiniz. Örneğin sadece fatura için ["order.invoice.ready"], sipariş durumu + fatura için ["order.status.changed","order.invoice.ready"] kullanabilirsiniz.

Gönderilen stok bildirimi

{ "schema_version": "1.2", "event_id": "xsu_...", "event_type": "product.stock.changed", "occurred_at": "2026-10-04T10:30:00Z", "payload": { "product_id": 1234, "sku": "XSU-ABC123", "stock": 0, "stock_status": "outofstock" } }
Alıcı endpoint başarılı kabul için HTTP 2xx dönmelidir. Client ID / Client Secret webhook adresine gönderilmez; API erişimi ve webhook endpoint doğrulaması birbirinden ayrıdır.

Bağlantı sağlığı

  1. Webhook kaydedildiğinde endpoint doğrulanır.
  2. Teslimat başarısız olursa bağlantı sorunu kaydedilir ve bayi e-posta ile bilgilendirilir.
  3. Sistem yaklaşık 5 dakikalık aralıklarla yeniden dener.
  4. 60 dakika boyunca hiçbir başarılı HTTP 2xx alınamazsa webhook otomatik pasife alınır.
  5. Sorun giderildikten sonra PUT /webhooks/{id}/activate ile aynı kayıt yeniden aktifleştirilebilir.