API - Genel bakış

API - Uç nokta listesi

Uç noktayı, gereken yöntemi ve izinleri bulun, ardından ayrıntılı örneğe geçin.

Uç noktalara genel bakış

Aşağıdaki tablo, backend-public-api/app.js içinde bağlı herkese açık rotaları yansıtır. Yollar, dış entegrasyonların kullandığı genel proxy önekiyle gösterilir.

YöntemUç noktaAçıklamaErişim
GET/public-api/healthzHizmet durum kontrolü.herkese açık
GET/public-api/v1/auth/checkKimlik bilgilerini doğrular; mağazayı, izinleri ve plan özelliklerini döndürür.kimliği doğrulanmış herhangi bir kimlik bilgisi
GET/public-api/v1/customer-ordersSayfalanmış ve filtrelenebilir müşteri sipariş listesini döndürür.orders:read
GET/public-api/v1/customer-orders/:idYapılandırılmış ürün öğeleriyle tek müşteri siparişini döndürür.orders:read
POST/public-api/v1/customer-orders/batchKimliklere göre en fazla 100 sipariş döndürür.orders:read
PATCH/public-api/v1/customer-orders/:id/statusSipariş durumunu günceller.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantitySeçili sipariş ayrıntılarının miktarlarını günceller.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantity/allSiparişteki tüm öğelere tek bir miktar atar.orders:write
DELETE/public-api/v1/customer-orders/:idMağaza sahibine ait müşteri siparişini siler.orders:write
GET/public-api/v1/productsYerleştirme kullanılabilirliği ve medya URL’leriyle mağaza ürünlerini/tasarımlarını döndürür.products:read
GET/public-api/v1/products/:idTek mağaza ürünü/tasarımı döndürür.products:read
POST/public-api/v1/embed/sessionModel oluşturucu dahil gömülü araçlar için kısa ömürlü bir JWT verir.embed:session:create
GET/public-api/v1/runtime/bootstrapYerleştirme JWT’sinden çalışma zamanı bağlamını çözümler.Bearer yerleştirme belirteci
GET/public-api/v1/assetsİstenen türdeki varlık kataloğu öğelerini listeler.kimliği doğrulanmış herhangi bir kimlik bilgisi
GET/public-api/v1/assets/:type/:assetIdİndirilebilir dosya rolleri içeren varlık manifesti döndürür.kimliği doğrulanmış herhangi bir kimlik bilgisi
GET/public-api/v1/assets/:type/:assetId/files/:roleRolüne göre varlık dosyası indirir.kimliği doğrulanmış herhangi bir kimlik bilgisi
GET/public-api/v1/design-importsAlter’da barındırılan, içe aktarılabilir tasarımları listeler.kimliği doğrulanmış kimlik bilgisi, Business planı gerekir
GET/public-api/v1/design-imports/:idTasarım içe aktarma verilerini ve dosya tanımlayıcılarını döndürür.kimliği doğrulanmış kimlik bilgisi, Business planı gerekir
GET/public-api/v1/design-imports/:id/files/:fileIdTasarım içe aktarma tanımlayıcısındaki dosyayı indirir.kimliği doğrulanmış kimlik bilgisi, Business planı gerekir
GET/public-api/v1/file/public/products/:productId/:sizeHerkese açık ürün önizlemesini döndürür. Boyut small.png, medium.png veya big.png olmalıdır.herkese açık
GET/public-api/v1/file/protected/:keyDepolama anahtarına göre korumalı dosya döndürür.imzalı URL veya files:read
GET/public-api/v1/fontsKullanılabilir tüm yazı tiplerini döndürür.herkese açık
GET/public-api/v1/currenciesTüm para birimlerini döndürür.herkese açık
POST/public-api/v1/runtime-bindings/sync-from-wordpressWordPress ürün eşleştirmelerinden çalışma zamanı bağları oluşturur veya günceller.kimliği doğrulanmış herhangi bir kimlik bilgisi
PATCH/public-api/v1/runtime-bindings/:idÇalışma zamanı bağını kısmen günceller.kimliği doğrulanmış herhangi bir kimlik bilgisi
POST/public-api/v1/runtime-bindings/:id/activateÇalışma zamanı bağını etkinleştirir.kimliği doğrulanmış herhangi bir kimlik bilgisi
POST/public-api/v1/runtime-bindings/:id/deactivateÇalışma zamanı bağını devre dışı bırakır.kimliği doğrulanmış herhangi bir kimlik bilgisi
POST/public-api/v1/wp-connect/exchangeWordPress otomatik bağlantı aktarım kodunu API kimlik bilgileriyle değiştirir.tek kullanımlık aktarım kodu
GET/public-api/v1/model-generator/catalogGörünür oluşturucu ürünlerini, yapılandırmaları ve şablon revizyonlarını listeler.embed:session:create
GET/public-api/v1/model-generator/modelsİçe aktarma için belirli oluşturucu kaynak revizyonlarını sabitleyen tanımlayıcılara sahip modelleri listeler.embed:session:create
GET/public-api/v1/model-generator/designer-catalogDesigner tarafından kullanılan oluşturucu model kataloğunu döndürür.embed:session:create
GET/public-api/v1/model-generator/projectsSahibin oluşturucu projelerini ve genel kullanıma açık oluşturucu projelerini listeler.embed:session:create
GET/public-api/v1/model-generator/projects/:projectIdEn son veya seçilen proje revizyonunu, şablonu ve dosya bildirimini döndürür.embed:session:create
GET/public-api/v1/model-generator/projects/:projectId/revisions/:revisionEn son veya seçilen proje revizyonunu, şablonu ve dosya bildirimini döndürür.embed:session:create
GET/public-api/v1/model-generator/projects/:projectId/artifacts/:artifactIdProjesine erişimi kontrol ettikten sonra bir çıktı dosyasını indirir.embed:session:create
GET/public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/templateSeçilen yapılandırma revizyonu için erişilebilir bir şablon belgesi döndürür.embed:session:create
GET/public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/importŞablon içe aktarma paketini bağımlılık dosyalarıyla birlikte döndürür.embed:session:create
GET/public-api/v1/model-generator/mannequinsHer iki mankeni ve kaynak tanımlayıcılarını döndürür.embed:session:create
GET/public-api/v1/model-generator/image-libraries/:kind/assetsDoku veya arka plan kitaplığındaki varlıkları içe aktarılabilir dosyalarla birlikte listeler.embed:session:create
GET/public-api/v1/model-generator/image-libraries/:kind/assets/:assetIdTek bir doku veya arka plan varlığını içe aktarılabilir dosyalarıyla birlikte döndürür.embed:session:create
GET/public-api/v1/model-generator/public-files/:keyİzin verilen bir oluşturucu bağımlılık dosyasını indirir.embed:session:create