İçeriğe geç
Docs

Public API Referansı

Vitrin /api/store sözleşmesi: auth başlıkları, render, CMS, e-ticaret, müşteri hesabı, analytics ve ödeme sağlayıcı geri dönüşleri.

Son güncelleme:

Bu sayfa canlı tema, headless storefront, checkout ve analytics için dışarı verilmesi uygun olan mevcut API yüzeyini özetler.

Base URL örneği:

Metin
https://api.tecof.com

Auth Başlıkları#

Storefront secret key#

Canlı tema API'leri merchant bağlamını x-secret-key ile çözer:

HTTP
x-secret-key: merchant_secret_key
Content-Type: application/json

Customer auth#

Müşteri hesabı gerektiren uçlarda customer JWT eklenir:

HTTP
x-secret-key: merchant_secret_key
Authorization: customer_jwt

Editor write auth#

Editör mutasyonları secret key'e ek olarak merchant/team JWT ister:

HTTP
x-secret-key: merchant_secret_key
Authorization: merchant_or_team_jwt

Tema ve Render API'leri#

MetotEndpointAuthAçıklama
GET/api/store/editor/:idsecret keyEditör için draft sayfa verisini getirir
PUT/api/store/editor/:idsecret key + JWTSayfa draft verisini kaydeder
POST/api/store/render?themeId=:themeId&locale=:localesecret keyYayındaki sayfayı slug ile render için getirir
GET/api/store/merchant-infosecret keyDil, default dil, logo, favicon, custom script ve under construction bilgisini getirir
GET/api/store/pagessecret keyLink alanları ve sitemap için sayfa listesini getirir
POST/api/store/uploadsecret key + opsiyonel JWTDosya upload eder
GET/api/store/uploadssecret key + opsiyonel JWTMedya kütüphanesini listeler
POST/api/store/translatesecret key + opsiyonel JWTMetni birden çok dile çevirir
GET/api/store/shared-componentssecret keyShared component listesini getirir
POST/api/store/shared-componentsstrict auth ayarına bağlıShared component oluşturur
POST/api/store/stock-media/searchsecret key + opsiyonel JWTStok görsel arar
POST/api/store/stock-media/importsecret key + opsiyonel JWTStok görseli merchant storage'a aktarır
POST/api/store/component-previewsecret key + opsiyonel JWTComponent screenshot PNG üretir

/api/store/render body örneği:

JSON
{
  "slug": "home",
  "themeId": "theme_id",
  "locale": "tr",
  "showDraftData": false
}

Storefront CMS API'leri#

Bu uçlar sadece canlı içerik döndürür. Taslak item'lar sızmaz; published item'lar ve zamanı gelmiş scheduled item'lar görünür.

MetotEndpointAuthAçıklama
POST/api/store/cms/collectionssecret keyAktif collection listesini getirir
POST/api/store/cms/collections/:slugsecret keyCollection detayını slug ile getirir
POST/api/store/cms/collections/:slug/itemssecret keyCollection item listesini getirir
POST/api/store/cms/collections/:slug/items/:itemSlugsecret keyTek item'ı slug ile getirir
POST/api/store/cms/items/:idsecret keyTek item'ı ID ile getirir

Item liste body örneği:

JSON
{
  "locale": "tr",
  "page": 1,
  "limit": 20,
  "sort": "newest"
}

Storefront E-Ticaret API'leri#

MetotEndpointAuthAçıklama
GET/api/store/ecommerce/categoriessecret keyKategori ağacı
GET/api/store/ecommerce/productssecret keyÜrün listesi ve filtreleme
GET/api/store/ecommerce/products/:slugsecret keyÜrün detayı
GET/api/store/ecommerce/products/:slug/relatedsecret keyBenzer ürünler
GET/api/store/ecommerce/search/suggestsecret keyÜrün/kategori autocomplete
GET/api/store/ecommerce/products/:productId/reviewssecret keyOnaylı yorumlar ve puan özeti
POST/api/store/ecommerce/products/:productId/reviewscustomer authÜrün yorumu gönderir
POST/api/store/ecommerce/cart/validatesecret keySepeti stok/fiyat/indirim için doğrular
POST/api/store/ecommerce/checkoutsecret keySepetten sipariş oluşturur
POST/api/store/ecommerce/coupon/validatesecret keyKuponu sepete göre doğrular
POST/api/store/ecommerce/shipping/ratessecret keyAdrese göre kargo seçenekleri
POST/api/store/ecommerce/checkout/initiate-paymentsecret keyCheckout ödeme formunu başlatır
POST/api/store/ecommerce/checkout/callbacksecret keyStorefront ödeme callback sonucu
POST/api/store/ecommerce/checkout-sessionsecret keyHosted checkout session oluşturur
GET/api/store/ecommerce/checkout-session/:uuidpublicHosted checkout session getirir
PUT/api/store/ecommerce/checkout-session/:uuidpublicHosted checkout session günceller
GET/api/store/ecommerce/push/configsecret keyVAPID public key
POST/api/store/ecommerce/push/subscribesecret keyPush aboneliği oluşturur
POST/api/store/ecommerce/push/unsubscribesecret keyPush aboneliğini kaldırır
POST/api/store/ecommerce/email/subscribesecret keyBülten aboneliği oluşturur

Ürün liste query parametreleri:

Metin
locale, page, limit, sort, category, brand, search, minPrice, maxPrice, tag

Desteklenen sort değerleri:

Metin
newest, oldest, priceAsc, priceDesc, nameAsc, nameDesc

Müşteri Hesabı API'leri#

MetotEndpointAuthAçıklama
POST/api/store/ecommerce/customer/registersecret keyMüşteri kaydı
POST/api/store/ecommerce/customer/loginsecret keyMüşteri girişi
POST/api/store/ecommerce/customer/convert-guestsecret keyGuest müşteriyi hesaba çevirir
POST/api/store/ecommerce/customer/verify-emailsecret keyE-posta doğrular
POST/api/store/ecommerce/customer/resend-verificationcustomer authDoğrulama e-postasını yeniden gönderir
POST/api/store/ecommerce/customer/forgot-passwordsecret keyŞifre sıfırlama e-postası ister
POST/api/store/ecommerce/customer/reset-passwordsecret keyŞifre sıfırlar
GET/api/store/ecommerce/customer/mecustomer authProfil getirir
PUT/api/store/ecommerce/customer/mecustomer authProfil günceller
PUT/api/store/ecommerce/customer/passwordcustomer authŞifre değiştirir
GET/api/store/ecommerce/customer/orderscustomer authSiparişleri listeler
GET/api/store/ecommerce/customer/orders/:orderNumbercustomer authSipariş detayı
GET/api/store/ecommerce/customer/addressescustomer authAdresleri listeler
POST/api/store/ecommerce/customer/addressescustomer authAdres ekler
PUT/api/store/ecommerce/customer/addresses/:addressIdcustomer authAdres günceller
DELETE/api/store/ecommerce/customer/addresses/:addressIdcustomer authAdres siler
PUT/api/store/ecommerce/customer/addresses/:addressId/defaultcustomer authVarsayılan adres yapar

Analytics API'leri#

MetotEndpointAuthAçıklama
POST/api/analytics/eventpublicStorefront event toplar, başarılıysa 204 No Content döner
GET/api/analytics/statsJWTPageview, visitor, referrer, device ve top URL istatistikleri
GET/api/analytics/liveJWTAnlık ziyaretçi, bugünkü oturumlar ve checkout davranışı

Event payload örneği:

JSON
{
  "merchantId": "merchant_id",
  "url": "/products/example",
  "referrer": null,
  "type": "cart_add",
  "data": {
    "productId": "product_id",
    "quantity": 1
  },
  "ts": 1760000000000
}

Desteklenen event tipleri:

Metin
pageview, custom, web-vital, cart_add, cart_remove, checkout_start

Payment Provider Callback#

Ödeme sağlayıcılarının çağırdığı public callback endpoint:

MetotEndpointAuthAçıklama
POST/api/merchant/ecommerce/payments/callback/:providerpubliciyzico veya paytr callback işler

Bu endpoint müşteri tarayıcısından manuel çağrılmak için değil, ödeme sağlayıcı sunucularının callback'i için tasarlanmıştır.