Uygulama yapılandırma dosyaları
biticaret.app.toml ve biticaret.extension.toml dosyalarının nasıl çalıştığı.
Bir uygulamanın klasörü yapılandırmasını TOML dosyalarında tutar. CLI manifesti ve yüklenen paketi bu dosyalardan kurar; platform yüklemede aynı denetimleri yapar.
my-app/
biticaret.app.toml
biticaret.app.staging.toml # isteğe bağlı, bir ortamın dosyası
extensions/
tier-discount/
biticaret.extension.toml
...
biticaret.app.toml
Uygulamanın kendisi: kimliği, adresleri, istediği izinler ve müşteri verisi düzeyi, webhook abonelikleri, KVKK adresleri, uygulama vekili, yönetim panelindeki sayfası, bir ödeme uygulamasıysa ödeme adresleri ve bir SMS sağlayıcısıysa bunu söyleyen anahtarlar. Dosyadaki adresler application_url sunucusunda yol olarak yazılabilir.
client_id = "..."
handle = "my-app"
name = "Uygulamam"
application_url = "https://app.example.com"
[access_scopes]
scopes = ["read_products", "read_customers"]
[customer_data]
level = 1
reason = "Sadakat puanlarını müşterinin hesabına yazmak için."
[auth]
redirect_urls = ["/auth/callback"]
[privacy]
customers_data_request_url = "/webhooks/customers/data_request"
customers_redact_url = "/webhooks/customers/redact"
store_redact_url = "/webhooks/store/redact"
[[webhooks.subscriptions]]
topics = ["products/update"]
uri = "/webhooks"
Müşteri verisi düzeyi. Müşteriye ulaşabilen izinler veya özellikler kullanan uygulama [customer_data] bloğunu yazar: level 0 (müşteri verisi yok), 1 (ad ve iletişim bilgisi olmadan) veya 2 (ad ve iletişim bilgisiyle), 1'den itibaren reason ile. Düzey sürüm incelemesinde onaylanır ve API ile webhook'ların hangi alanları verdiğini belirler: Uygulama API'si.
Uygulama vekilinde büyük yanıtlar. Vekil üzerinden dosya sunan bir uygulama app_proxy.large_responses = true ve large_responses_reason ile büyük yanıtlar ister. Platform izin verirse GET ve HEAD için sınırlar 120 saniye ve 256 MiB olur; izin verilmeyen bir sürüm reddedilmez, olağan sınırlarla çalışır.
SMS sağlayıcısı. sms_provider = true uygulamayı mağazanın seçebileceği bir SMS sağlayıcısı yapar (write_sms gerekir): platformun bildirim SMS'lerini sms/send ile alır. sms_commercial = true ayrıca kampanya SMS'lerini İYS süzgeciyle gönderir ve iys/consent ile izinleri İYS'ye işler: Webhook'lar.
Her anahtar: biticaret.app.toml anahtarları. İzinler: İzinler. Konular: Webhook konuları.
Ortamlar
biticaret.app.<ortam>.toml bir ortamın dosyasıdır, kendi uygulamasının client_id değeriyle. biticaret app config use <ortam> onu varsayılan yapar; --config <ortam> tek bir komut için seçer. app config link dosyayı platformdaki uygulamadan yazar; client_id satırı olmayan bir dosyayı korur ve yalnızca o satırı ekler, böylece biticaret.app.toml dosyasının kopyası, kendi application_url adresiyle, o ortamın dosyası olur. Ortam dosyaları ortamın uygulamasını gösterir; onları git dışında tutabilirsiniz.
biticaret.extension.toml
extensions/ altındaki her klasör bir uzantıdır ve kendi biticaret.extension.toml dosyasını taşır. type anahtarı uzantının türünü söyler: theme (tema blokları), function (ödeme adımı fonksiyonu), ui_extension (arayüz uzantısı) veya web_pixel. Diğer anahtarlar türe göre değişir.
type = "function"
handle = "tier-discount"
function_type = "discount"
title = "Kademeli indirim"
[build]
command = "tinygo build -o tier-discount.wasm -target wasi ."
path = "tier-discount.wasm"
Bir arayüz uzantısı ayarının varsayılanı "https://APPBASE" ise CLI onun yerine application_url adresinin şemasını ve alan adını yazar (https://app.example.com): uzantı, her ortamın dosyasıyla, uygulamayı çalıştığı adreste çağırır.
biticaret app generate extension --type <tür> --name <ad> bir uzantıyı türün şablonundan başlatır. Her türün anahtarları: biticaret.extension.toml anahtarları. Fonksiyon türleri: Ödeme adımı fonksiyonları. Hedefler: Arayüz uzantısı hedefleri.
Denetim
biticaret app check dosyaları okur ve her sorunu dosyası, satırı ve anahtarıyla yazar. Platform yüklemede iki şeyi daha denetler: uygulama vekilinin yolunu başka bir uygulamanın kullanmadığını ve birinci taraf izinleri yalnızca birinci taraf bir uygulamanın istediğini.