geliştirici belgeleri

biticaret.app.toml anahtarları

Uygulama dosyasının bütün anahtarları, türleri ve anlamları.

Bu sayfa koddan üretilir. a.b anahtarı [a] tablosundaki b anahtarıdır; a[].b ise [[a]] tablo dizisinin her öğesindeki b anahtarıdır. Dosyaların nasıl çalıştığı için Uygulama yapılandırma dosyaları sayfasına bakın.

Anahtar Tür Anlamı
client_id metin Uygulamanın istemci kimliği. app config link yazar; CLI uygulamayı ve giriş yapılan organizasyonu bununla bulur.
handle metin Uygulamanın kısa adı: küçük harf, rakam ve tire, en fazla 50 karakter.
name metin Uygulamanın mağazalara görünen adı.
application_url metin Uygulamanın adresi (https). Dosyadaki diğer adresler bu adresin sunucusunda yol olarak yazılabilir.
access_scopes.scopes metin dizisi Uygulamanın istediği izinler; kurulumda mağaza onaylar. İzinler sayfasına bakın.
auth.redirect_urls metin dizisi OAuth kurulumunun dönebileceği adresler.
customer_data.level tam sayı Uygulamanın müşteri verisi düzeyi: 0 (müşteri verisi yok), 1 (ad ve iletişim bilgisi olmadan) veya 2 (ad ve iletişim bilgisi ile). Müşteriye ulaşabilen izinler veya özellikler kullanan uygulama bu bloğu yazmak zorundadır.
customer_data.reason metin Müşteri verisinin neden gerektiği; 1. düzeyden itibaren zorunludur.
privacy.customers_data_request_url metin customers/data_request konusunun gönderildiği adres (KVKK, zorunlu).
privacy.customers_redact_url metin customers/redact konusunun gönderildiği adres (KVKK, zorunlu).
privacy.store_redact_url metin store/redact konusunun gönderildiği adres (KVKK, zorunlu).
webhooks.subscriptions[].topics metin dizisi Bu aboneliğin konuları. Webhook konuları sayfasına bakın.
webhooks.subscriptions[].uri metin Bu aboneliğin konularının gönderildiği adres.
app_proxy.subpath metin Vitrinde uygulamaya ayrılan yol: /apps/<subpath> altındaki istekler uygulamaya iletilir.
app_proxy.url metin Uygulama vekilinin isteklerinin iletildiği adres.
app_proxy.large_responses boolean true ise uygulama büyük proxy yanıtları ister (GET ve HEAD için 120 sn, 256 MiB); platform izin verirse geçerli olur, sürüm istediği için reddedilmez.
app_proxy.large_responses_reason metin Büyük proxy yanıtlarının neden gerektiği; large_responses true iken zorunlu, en fazla 1000 karakter. İncelemede gösterilir.
admin_embedded.entry_url metin Yönetim panelinde uygulamanın sayfası olarak açılan adres.
admin_embedded.navigation[].label metin Yönetim panelinde uygulamanın altındaki bir menü bağlantısının adı.
admin_embedded.navigation[].path metin Menü bağlantısının entry_url altındaki yolu.
payments_app.label metin Ödeme yönteminin ödeme adımında görünen adı.
payments_app.payment_session_url metin Ödeme isteklerinin gönderildiği adres.
payments_app.refund_session_url metin İade isteklerinin gönderildiği adres.
payments_app.capture_session_url metin Tahsilat isteklerinin gönderildiği adres.
payments_app.void_session_url metin İptal isteklerinin gönderildiği adres.
payments_app.supported_currencies metin dizisi Uygulamanın kabul ettiği para birimleri (ISO 4217, örneğin TRY).
payments_app.supports_installments boolean Uygulama taksitli ödeme alabilir.
payments_app.supports_installment_quotes boolean Uygulama installment_quote_url adresinde taksit seçeneklerini yanıtlar; yoksa ödemeler tek çekimdir.
payments_app.installment_quote_url metin Taksit seçeneklerinin sorulduğu adres.
payments_app.supports_3ds boolean Uygulama 3D Secure doğrulaması yapar.
payments_app.invoice boolean Ödeme adımı yöntemi fatura olarak gösterir ve sipariş, mağaza tahsil edene kadar bekler. Yalnızca bir şirket şubesinin ödeme koşullarıyla anlamlıdır.
payments_app.test_only boolean Uygulama yalnızca test ödemesi alır, gerçek para taşımaz. Platform yalnızca test: true istekleri gönderir ve bu açıkken mağaza açılamaz.
sms_provider boolean true ise uygulama mağazanın SMS sağlayıcısı olabilir: bildirim SMS'lerini sms/send konusuyla alır (write_sms kapsamı gerekir).
sms_commercial boolean true ise SMS sağlayıcı uygulama kampanya (ticari) SMS'lerini İYS filtresiyle gönderebilir ve mağazanın topladığı izinleri iys/consent ile İYS'ye kaydeder; sms_provider gerekir.