3 adımda başlayın
İlk isteğiniz
1. Sandbox mağazası alın
Sandbox formu geliştirici e-postanızı alır; size özel 30 günlük deneme mağazası ve
Sandbox başvurususyk_test_anahtarı oluşturur. Sentetik katalogla güvenle deneyin.2. Anahtarı güvenli saklayın
Anahtar yalnız bir kez gösterilir. Sunucu tarafında gizli ortam değişkeninde tutun; tarayıcı koduna veya sürüm kontrolüne koymayın.
export API_BASE="$(jq -r '.servers[0].url' openapi.json)"3. Ürünleri okuyun
curl "$API_BASE/api/vitrin/eklenti/api_anahtarlari/v1/products" \ -H "Authorization: Bearer syk_test_…" \ -H "X-Store-Id: <sandbox-mağaza-kimliği>"Başarılı yanıtta JSON içindeki
dataalanında ürünler bulunur. Canlı API anahtarı yalnız kendi mağazanızda çalışır. Canlı API anahtarı Pro ve Premium paketlerde açılır; sandbox denemesi için paket gerekmez.
Erişim güvenliği
Kimlik doğrulama ve kapsamlar
Her istekte Authorization: Bearer syk_… başlığını gönderin. API anahtarları mağazaya bağlıdır; başka mağazanın anahtarı eşleşmez. Sandbox anahtarları syk_test_, canlı anahtarlar syk_ ile başlar ve ortamlar arasında kabul edilmez.
| Kapsam | İzin |
|---|---|
products:read | Ürünleri ve tek ürünü okuma |
products:write | Ürün fiyatı güncelleme |
categories:read | Kategori ağacını okuma |
stock:read / stock:write | Stok okuma / güncelleme |
orders:read / orders:write | Sipariş okuma / not ve takip bilgisi güncelleme |
shipments:read | Kargo ve takip durumunu okuma |
webhooks:read / webhooks:write | Webhook uçlarını listeleme / ekleme / silme |
Yalnız işiniz için gereken kapsamları seçin. customers:read kapsamı sunulmaz. Partner OAuth uygulama kaydı bu sürümde yoktur.
Oran sınırı
Her API anahtarının dakikalık sınırı anahtar ayarına göre uygulanır. Yanıtlar X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset başlıklarıyla sınırı bildirir. 429 yanıtında Retry-After süresini bekleyip üstel gecikmeyle yeniden deneyin.
Sürümleme ve kullanım dışı bırakma
REST yolları /v1 ile sürümlenir. Kırıcı değişiklik yeni ana sürümde yayımlanır. Kullanım dışı uçlar Deprecation ve Sunset başlıklarıyla tarih bildirir; yanıt gövdesi ve portal değişiklik günlüğü geçiş yolunu açıklar.
OpenAPI şeması ve istek/yanıt örnekleri: openapi.json.
API referansı
Bu tablo, bağımlılık eklemeden openapi.json üzerinden oluşturulur. Böylece portal istemci tarafında küçük kalır; tam OpenAPI belgesi doğrudan alınabilir.
API uçları yükleniyor… OpenAPI JSON’u açın.
Olay odaklı entegrasyon
Webhook olayları
product.createdproduct.deletedproduct.changedstock.changedorder.createdorder.paidorder.shippedorder.status_changedrefund.created,refund.approved,refund.rejected
Webhook yönetimi API anahtarıyla GET /webhooks, POST /webhooks ve DELETE /webhooks/{id} üzerinden yapılır. Teslimat başlıkları: X-SendeYok-Event, X-SendeYok-Delivery, X-SendeYok-Timestamp, X-SendeYok-Signature.
İmzayı JSON’u çözmeden, ham istek gövdesiyle doğrulayın. İmzalı metin timestamp + "." + raw_body; HMAC-SHA256 hex değeri sha256= öneki alır. Zaman damgası en çok 5 dakika eski olabilir; aynı teslimat kimliğini ikinci kez işlemeyin.
PHP doğrulama örneği
<?php
$hamGövde = file_get_contents('php://input');
$zaman = $_SERVER['HTTP_X_SENDEYOK_TIMESTAMP'] ?? '';
$imza = $_SERVER['HTTP_X_SENDEYOK_SIGNATURE'] ?? '';
if (abs(time() - (int) $zaman) > 300) { http_response_code(401); exit; }
$beklenen = 'sha256=' . hash_hmac('sha256', $zaman . '.' . $hamGövde, $gizliAnahtar);
if (!hash_equals($beklenen, $imza)) { http_response_code(401); exit; }
http_response_code(200);JavaScript doğrulama örneği
import { createHmac, timingSafeEqual } from "node:crypto";
const zaman = request.headers.get("x-sendeyok-timestamp") ?? "";
const gelen = request.headers.get("x-sendeyok-signature") ?? "";
const hamGövde = await request.text(); // JSON.parse öncesi ham bayt dizgesi
if (Math.abs(Date.now() / 1000 - Number(zaman)) > 300) throw new Error("Eski istek");
const beklenen = "sha256=" + createHmac("sha256", gizliAnahtar).update(zaman + "." + hamGövde).digest("hex");
if (gelen.length !== beklenen.length || !timingSafeEqual(Buffer.from(gelen), Buffer.from(beklenen))) throw new Error("Geçersiz imza");Python doğrulama örneği
import hmac, hashlib, time
zaman = request.headers.get("X-SendeYok-Timestamp", "")
gelen = request.headers.get("X-SendeYok-Signature", "")
ham_govde = request.get_data(cache=True) # JSON çözümlemesinden önceki ham gövde
if abs(time.time() - int(zaman)) > 300:
abort(401)
beklenen = "sha256=" + hmac.new(gizli_anahtar.encode(), zaman.encode() + b"." + ham_govde, hashlib.sha256).hexdigest()
if not hmac.compare_digest(gelen, beklenen):
abort(401)Her platforma bağlanın
Otomasyon ve yapay zekâ araçları
Zapier
Mağaza API anahtarınızı bağlayın; sipariş/ürün/stok tetikleyicileriyle akış kurun.
Make
Hazır SendeYok modülünde tetikleyici veya eylem seçin; bağlantıda anahtar kullanın.
n8n
Topluluk düğümünde API anahtarınızı saklayıp olayları iş akışlarına taşıyın.
MCP
mcp_ve_cli eklentisinin mağaza MCP sunucusunu istemcinize tanımlayın; yazma eylemleri mağaza onayına tabidir.
Zapier/Make/n8n kurulum ayrıntıları mağazanızdaki mevcut entegrasyon eklentisinin yönergelerine dayanır. MCP bağlantısı ilgili eklenti kurulumu gerektirir.
Sık sorulan sorular
Sandbox anahtarı canlı veriye erişir mi?
Hayır. Test anahtarı yalnız sandbox ortamında; canlı anahtar yalnız canlı mağazada kabul edilir.
Anahtarımı kaybettim, yeniden görebilir miyim?
Güvenlik için oluşturulan anahtar tekrar gösterilmez. Eskisini iptal edip yeni anahtar üretin.
Müşteri bilgilerini okuyabilir miyim?
Hayır. customers:read kapsamı sunulmaz; API sipariş müşteri iletişim bilgilerini açmaz.
İstek sınırına ulaşırsam ne yapmalıyım?
Retry-After kadar bekleyin, kalan istek başlığını izleyin ve gecikmeli tekrar deneyin.
Eski API sürümü ne kadar açık kalır?
Kullanım dışı bırakma tarihi Sunset başlığında bildirilir. Geçiş için portal değişiklik günlüğünü izleyin.