İçeriğe geç
siparis.app geliştiriciAnahtarları yönet ↗

Kapsamlar ve kişisel veri

siparis.app API yetkisi, işletmeye ait bağlantının kapsamları ve marka sınırından oluşur. İstekler https://api.siparis.app/v1 adresine Bearer anahtarıyla gönderilir; panel çerezi veya kişinin ekip rolü API kapsamı yerine geçmez. /v1/me geçerli kapsam ve markaları gösterir.

orders:read, customers:read, products:read, inventory:read ilgili kaynakları açar. Siparişin ödeme, iade, gönderi ve fatura alt uçları orders:read yanında sırasıyla payments:read, returns:read, shipments:read, invoices:read ister. Yazma kapsamı okuma izni vermez. Her ucun gerekli ve isteğe bağlı kapsamları kendi sayfasında listelenir (Bütün uçlar).

events:read tek başına tüm olayları açmaz; olayın kaynağını okuma kapsamı da gerekir. Dışa aktarma exports:write yanında kaynağın okuma kapsamını ister. Webhook yönetimi webhooks:manage, seçilen olayların okunması da kaynak kapsamlarını ister.

Kişisel alanlar için kaynak iznine ek olarak personal_data:read gerekir; kapsam yokken alanlar yanıttan atlanır. İşletme sahibi KVKK uyarısını görerek açıkça seçer; varsayılan kapalıdır. E-posta/telefon eşitlik araması da bu izni ister. Alış fiyatı, KDV seçimi ve tedarikçi yazmak inventory:write yanında costs:write ister; yazma izni maliyeti okuma izni vermez. Maliyet costs:read, iç not internal_notes:read ile açılır; kişisel kaynaktaki iç not için iki kapsam da gerekir. Verileri yalnız izin verilen amaçla kullanın; yurt dışına aktarım dahil KVKK yükümlülüklerini değerlendirin.

customers:erase geri alınamaz KVKK anonimleştirmesi için ayrı hassas kapsamdır. İşletme sahibi yalnız Özel şablonda kendisi seçer; hiçbir hazır şablonda açık değildir. POST /v1/customers/{id}/anonymize ayrıca customers:write ve personal_data:write, Idempotency-Key ve {"confirm":"anonymize"} onayı ister. Kayıtlar silinmez; kişisel alanlar anonimleşir, sipariş, kesilmiş fatura ve muhasebe kayıtları kalır. KVKK silme isteği.

Bir markaya bağlı anahtar başka markanın verisini okuyamaz. Tek markada açılan sınırlı anahtar, ikinci marka eklenince genişlemez. İşletme kapsamlı anahtar izinli tüm markaları okur; tek ve çok markalı kullanım aynı uçları kullanır.

Anahtar yönetimi yalnız işletme sahibindedir. Yönetici, sipariş görevlisi, satış temsilcisi ve markayla sınırlı ekip üyesi anahtar oluşturamaz/yönetemez. Paneldeki AI erişimleri ve durumları listeler, onayla iptal eder; anahtar/sır üretmez veya göstermez. Anahtar döndürmede eski anahtarın geçiş süresi 24 saat–7 gün arasında seçilir. Bağlantının iptali bütün anahtarlarını kapatır.

money_out:write para çıkışı doğuran iade ve iptal için ayrı hassas kapsamdır; hazır şablonlarda açık değildir. İade başlatma ve gerçekten verilen iadeyi kaydetme returns:write ile birlikte ister. Yan etkisiz önizleme ve kodsuz onay/ret kararı returns:write ister. Açık seçimle geri gönderim kodu açılması ayrıca shipments:write ister ve BasitKargo bakiyenizden ücretlidir. İade yazma ve tekrar yanıtlarında ödeme listesi/özeti yalnız payments:read ile görünür. İade almak ve para iadesi.

Bütün kapsamlar

İşletme sahibi anahtar veya uygulama onayı verirken seçer; yazma kapsamı okuma izni vermez. Alan: scopes.

KodTürkçe adıNe zaman
orders:readSiparişler · GörSiparişleri, satırlarını ve durum geçmişini okumak.
orders:writeSiparişler · DeğiştirSipariş açmak, onaylamak, teslim etmek, düzeltmek, iptal etmek; başka kanaldaki satışı bildirmek.
products:readÜrünler · GörÜrün, seçenek, kategori, ürün markası ve marka fiyatlarını okumak.
products:writeÜrünler · DeğiştirÜrün, seçenek, kategori, ürün markası ve marka fiyatı yazmak; toplu fiyat güncellemek.
inventory:readStok · GörDepoları, stok miktarlarını, stok hareketlerini ve belgelerini okumak.
inventory:writeStok · DeğiştirStok girişi, sayım, fire ve depolar arası taşıma; ürün açarken ilk stok; toplu stok sayımı.
customers:readMüşteriler · GörMüşteri kartlarını okumak; ad, telefon, e-posta ve adres için ayrıca personal_data:read gerekir.
customers:writeMüşteriler · DeğiştirMüşteri eklemek, güncellemek, arşivlemek ve geri getirmek.
shipments:readGönderiler · GörGönderileri okumak ve kargo etiketini indirmek.
shipments:writeGönderiler · DeğiştirKargo fiyatı sormak, gönderi açmak ve iptal etmek; iadede ücretli geri gönderim kodu açmak.
returns:readİadeler · GörSiparişin iade ve değişim kayıtlarını okumak.
returns:writeİadeler · Değiştirİade talebini onaylamak veya reddetmek, iadeyi önizlemek ve başlatmak.
invoices:readFaturalar · GörFaturaları okumak ve fatura belgesini indirmek.
invoices:writeFaturalar · DeğiştirFatura kesmek ve iptal etmek.
coupons:readKuponlar · GörKuponları okumak.
coupons:writeKuponlar · DeğiştirKupon eklemek ve güncellemek.
campaigns:readKampanyalar · GörKampanyaları okumak. Bu sürümde bu kapsamı isteyen uç yok.
campaigns:writeKampanyalar · DeğiştirKampanyaları değiştirmek. Bu sürümde bu kapsamı isteyen uç yok.
subscriptions:readAbonelikler · GörAbonelikleri okumak.
subscriptions:writeAbonelikler · DeğiştirAbonelikleri değiştirmek. Bu sürümde bu kapsamı isteyen uç yok.
payments:readÖdemeleri görSiparişin tahsilat ve geri ödemelerini, para özetini okumak.
channels:readKanalları görSatış kanallarını okumak.
events:readOlayları görOlay akışını okumak; olayın kaynağının okuma kapsamı da gerekir (ör. sipariş olayı için orders:read).
webhooks:manageWebhook yönetBu bağlantının webhook adreslerini eklemek, değiştirmek ve kapatmak.
exports:writeDışa aktarDışa aktarma dosyası hazırlamak ve indirmek; kaynağın okuma kapsamı da gerekir.
personal_data:readKişisel verileri görMüşteri adı, telefonu, e-postası ve adresini görmek; e-posta veya telefonla aramak. İşletme sahibi KVKK uyarısını okuyarak seçer.
personal_data:writeKişisel verileri değiştirMüşteri adı, telefonu, e-postası ve adresini yazmak.
costs:readMaliyet ve tedarikçiyi görAlış fiyatını, maliyeti ve tedarikçiyi görmek.
costs:writeAlış fiyatı ve tedarikçiyi yazAlış fiyatı, maliyet, KDV seçimi ve tedarikçi yazmak.
money_out:writePara çıkışıMüşteriye para iadesi doğuran iade, iptal ve düzeltmeler. Hazır şablonlarda kapalıdır.
internal_notes:readİç notları görSipariş, müşteri ve stoktaki iç notları görmek.
internal_notes:writeİç notları değiştirİç not yazmak.
archive:writeArşivle ve geri getirKayıtları arşivlemek ve arşivden geri getirmek.
customers:eraseKVKK anonimleştirmesiMüşteriyi KVKK kapsamında geri alınamaz biçimde anonimleştirmek. Yalnız Özel şablonda seçilir.

OAuth uygulamalarında izinler

Davetli uygulamalar aynı kapsamları kullanır. İstenen izinler uygulama kaydının alt kümesidir; yalnız işletme sahibi, tek bir marka için onaylar. Kişisel veri izinleri onay ekranında kırmızı başlıkla ve ayrı onay kutusuyla sunulur. Barındırma ülkesi Türkiye dışındaysa KVKK m.9 uyarısı gösterilir. Bağlantı ve izinler Entegrasyonlar > Bağlı uygulamalar'dadır. Yenileme izinleri büyütmez; yeni kapsam yeni onay gerektirir. Akış.