API’ye Genel Bakış

Sözleşme, uç dizini, OpenAPI dosyası ve tarayıcıdan deneme

Bu sayfa Selwise'in geliştiricilere açık HTTP uçlarının dizinidir; widget'ın açılışta çektiği yapılandırma uçları Açılış Uçları sayfasındadır. Her ailenin ayrıntısı (parametre tabloları, curl örnekleri, gerçek yanıtlar, hata durumları) kendi sayfasındadır. Widget'ı kullanıyorsanız bu uçları çağırmanız gerekmez; mobil uygulama, sunucu entegrasyonu veya kendi arayüzünüz (headless) için doğrudan çağırırsınız.

Önce Kimlik Doğrulama ve Erişim sayfasını okuyun: hangi uca hangi kimlikle gideceğinizi orası anlatır.

Sözleşme

  • Taban adres: https://api.selwise.com/api/v1
  • Makine-okur sözleşme: Bu dizinin tamamı OpenAPI biçiminde https://selwise.com/openapi.public.json adresinde yayımlanır (/openapi.json aynı dosyadır). Her uç x-selwise-tier taşır: integration kararlı entegrasyon sözleşmesidir, widget ise widget ve SDK trafiğidir ve istemci protokolüyle birlikte evrilir. Her ucun kimlik türü x-selwise-auth, gereken anahtar kapsamı x-selwise-scope alanındadır. Panelin kendi API'si ve /channels/** yayımlanmaz. Kod üreten araçlara ve yapay zekâ destekli geliştirici asistanlarına bu dosyayı verebilirsiniz.
  • Biçim: İstek ve yanıt gövdesi JSON'dur (Content-Type: application/json). Zaman damgaları, aksi yazılmadıkça ISO 8601 (yanıtlarda) ya da milisaniye cinsinden epoch (isteklerde eventTs, timestamp) biçimindedir.
  • Bilinmeyen alan: Gövdesi sınıfla doğrulanan uçlar (events/batch, users/identify, users/traits, newsletter, contacts/consent, business-events, scenarios/inbox) tanımadığı bir alanı 400 ile reddeder; sessizce yok saymaz. orders, consent ve search/log, search/click, recommendations/track/* gövdeyi sınıfla doğrulamaz ve fazladan alanı yok sayar (tek istisna: orders gövdesinde id alanı 400 verir). Alan adlarını tam yazın. Ayrıntı: Hatalar ve Sınırlar.
  • Durum kodu yetmez: events/batch, search/log ve benzeri analitik uçlar bilinmeyen site anahtarına bile 200 dönebilir; success alanına bakın.
  • Hız sınırları uca göre değişir; bir uç özel bir sınır taşımıyorsa IP başına dakikada 100 istek geçerlidir ve sınır uç başına ayrı sayılır. Bkz. Hız sınırları.

Tarayıcıdan deneme

Uç sayfalarındaki her işlemin Dene sekmesi, isteği kendi kanal anahtarınızla bu sayfadan gönderir. Okuma uçları olduğu gibi çalışır; yazma uçları her zaman deneme çalıştırması (x-selwise-dry-run: 1) olarak gider: istek doğrulanır, yetki kontrol edilir ama hiçbir şey yazılmaz, olay ya da kuyruk işi oluşmaz. API anahtarınız yalnızca bu sekmenin belleğinde tutulur ve sayfayı kapattığınızda silinir. Kurallar: Yazmadan denemek.

Makine-okur sözleşmenin tamamı tek dosyadır: openapi.public.json. Postman, Insomnia ya da bir kod üreticiye doğrudan verebilirsiniz.

Uç dizini

Kimlik sütunu: Alan = alan adı doğrulaması (veya anahtar, başlık yoksa), Anahtar = her zaman API anahtarı, Yok = yalnızca siteKey.

Açılış ve içerik

Yöntem ve yolKimlikNe yaparSayfa
GET /public/sites/:siteKey/configAlanKampanya, öneri, takip, arama, zenginleştirme, deney ve tema yapılandırmasının toplu yanıtıBu sayfa
GET /public/sites/:siteKey/tracking-configAlanYalnızca takip yapılandırmasıBu sayfa
GET /public/sites/:siteKey/integrationsAlanVeri katmanı, entegrasyon ve webhook ayarlarıBu sayfa
GET /public/sites/:siteKey/campaignsAlanAktif kampanyalarBu sayfa
GET /public/sites/:siteKey/widgetsAlanKullanımdan kalktı, her zaman boş listeBu sayfa
GET /public/sites/:siteKey/scriptsAlanBir yola ait özel script'lerBu sayfa
GET /public/sites/:siteKey/product-metrics/view-count, .../cart-count, POST .../batchAlanÜrün rozeti sayılarıBu sayfa

Ölçüm

Yöntem ve yolKimlikNe yaparSayfa
POST /public/sites/:siteKey/events/batchYokOlay toplu gönderimiOlay Gönderimi
POST /public/sites/:siteKey/metricsYokİstemci sağlık sayaçlarıOlay Gönderimi
POST /public/sites/:siteKey/ordersAlanSiparişSipariş API'si
POST /public/sites/:siteKey/users/identify, .../users/traitsAlanKullanıcı kimliklendirmeKullanıcı Kimliklendirme API'si
POST /public/sites/:siteKey/business-eventsAlanKendi sisteminizin olayı (senaryo tetikler)İş Olayları

Arama ve öneri

Yöntem ve yolKimlikNe yaparSayfa
GET /public/sites/:siteKey/search, .../search-config, .../search/suggestionsAlanArama, yapılandırma, öneri listesiArama API'si
POST /public/sites/:siteKey/search/log, .../search/click, .../search/zero-resultsYokArama analitiğiArama API'si
GET /public/sites/:siteKey/recommendations, POST .../recommendations/:widgetId/productsAlanÖneri şeritleri ve ürünleriÖneri API'si
POST /public/sites/:siteKey/recommendations/track/event, .../track/behaviorYokÖneri analitiğiÖneri API'si

Zenginleştirme ve sunucu taraflı render

Yöntem ve yolKimlikNe yaparSayfa
GET /public/sites/:siteKey/enrichments, .../product-factsAlanÜrüne ait blok içeriği, katalog gerçekleriZenginleştirme API'si
GET /public/sites/:siteKey/app/enrichmentsAnahtar (uygulama kanalı)Uygulama kanalı için hazır içerikZenginleştirme API'si
GET /public/sites/:siteKey/ssr/enrichmentsAnahtar (ssr_read)Sunucuda basılacak hazır HTMLSunucu Taraflı Render API

İzin ve abonelik

Yöntem ve yolKimlikNe yaparSayfa
POST ve DELETE /public/sites/:siteKey/consentAlanÇerez onayı kaydı ve geri çekmeOnay ve Bülten API'si
POST /public/sites/:siteKey/contacts/consentAnahtar (newsletter_subscribe)Pazarlama izni (kendi sunucunuzdan)Onay ve Bülten API'si
POST /public/sites/:siteKey/newsletterAlanBülten kaydıOnay ve Bülten API'si

Katalog

Yöntem ve yolKimlikNe yaparSayfa
POST /public/feeds/:tokenToken (yolda)Ürün beslemesini göndermeBesleme Gönderme

Widget'ın iç uçları

Deney ataması, segment değerlendirme, senaryo gelen kutusu, tarayıcı bildirim aboneliği, e-posta abonelikten çıkış bağlantıları ve görsel editör widget'ın kendi trafiğidir; sözleşmeleri Widget'ın Kendi Kullandığı Uçlar sayfasındadır.

Bu listede olmayan uçlar

/api/v1 altında Authorization: Bearer ister panelin uçları da vardır (/channels, /campaigns, /segments ...). Onlar panelin kendi arayüzü içindir ve burada belgelenmez. Yalnızca yukarıdaki /public/ uçları entegrasyon sözleşmesidir.

Açılış: config

Widget'ın açılışta çektiği config, tracking-config, integrations, campaigns, scripts ve product-metrics uçları ayrı sayfada: Açılış Uçları.

Headless örüntü

Mobil ya da sunucu entegrasyonunda tipik akış:

  1. Açılışta config çekilir (başlıksız istek ve x-selwise-api-key).
  2. Etkileşim oldukça events/batch gönderilir.
  3. Satın almada orders gönderilir.
  4. Giriş yapıldığında users/identify çağrılır.

Mobil uygulama için hazır SDK'yı kullanmak bu akışı sizin yerinize yürütür: Mobil SDK.

Son güncelleme: 14 Kasım 2026