Başlangıç

Kimlik doğrulama

Out API'de oturum DoLogin ile, panelde oluşturduğunuz API anahtarı ve şifresiyle açılır. Dönen ApiCode diğer tüm isteklerin JSON gövdesinde gönderilir.

API anahtarı oluşturmak

StockMount paneline giriş yapın ve Ayarlar menüsündeki API servis ayarları ekranını açın.
Anahtarı tanıyacağınız bir açıklama yazıp yeni anahtar oluşturun. Ekranda ApiKey ve ApiPassword değerleri görünür.
Bu iki değeri entegrasyonunuzun sunucu tarafındaki ayarlarına kaydedin.

Bir hesapta en fazla 2 API anahtarı olabilir.
Yalnızca aktif durumdaki anahtarlar giriş yapabilir.
Var olan bir anahtarı düzenlediğinizde API şifresi yenilenir; entegrasyonunuzdaki şifreyi de güncellemeniz gerekir.

DoLogin isteği

İstek gövdesi:

{
  "ApiKey": "API_ANAHTARINIZ",
  "ApiPassword": "API_SIFRENIZ"
}

İsteğe bağlı DeveloperId alanına entegrasyonunuzu tanımlayan bir ad yazabilirsiniz (ör. ornek-erp). Bu değer yalnızca kayıtlarda kullanılır. Başarılı yanıt:

{
  "Result": true,
  "Response": {
    "UserId": 104523,
    "Name": "Ayşe",
    "Surname": "Yılmaz",
    "Email": "ayse@ornekmagaza.com",
    "Username": "ornekmagaza",
    "PackageEndDate": "2027-03-31T00:00:00",
    "ApiCode": "q7XvT1kR9mN2bW4y…"
  }
}

ApiCode'u kullanmak

ApiCode değerini diğer tüm isteklerin gövdesine ApiCode alanı olarak ekleyin. HTTP başlığında (Authorization vb.) gönderilen bilgiler dikkate alınmaz.

{
  "ApiCode": "q7XvT1kR9mN2bW4y…",
  "IntegrationId": 2
}

ApiCode şifrelenmiş, opak bir metindir; +, / ve = karakterleri içerebilir. Olduğu gibi saklayın ve gönderin.

Oturum süresi ve yenileme

Oturum, aynı giriş bilgisiyle yapılan son girişten itibaren sınırlı bir süre geçerlidir (varsayılan 24 saat). Servis çağrıları süreyi uzatmaz.
Süre dolduğunda istekler Result: false ve ErrorCode: "00001" (bozuk kodda 00006) ile döner. Bu durumda DoLogin ile yeni bir ApiCode alın ve isteği bir kez tekrarlayın.
DoLogin'i her istekten önce çağırmayın. Oturum geçerliyken aynı giriş bilgisiyle yapılan yeni giriş aynı ApiCode değerini döndürür ve süreyi yeniden başlatır.
Her API anahtarının oturumu ayrıdır. Aynı anahtarı kullanan sistemler aynı ApiCode'u alır; farklı anahtarlar birbirinin ApiCode'unu etkilemez.

Giriş hataları

Kod	Anlamı
`00003`	Zorunlu alan eksik. `ErrorMessage` eksik alanın adını verir.
`00001`	Giriş başarısız. Hatalı bilgi, pasif hesap ve pasif anahtar aynı kodu döndürür; güvenlik nedeniyle ayrıntı verilmez.
`99988`	Hesapta API erişimi veren geçerli bir paket yok. Paketinizi panelden kontrol edin.

Güvenlik önerileri

API anahtarını, şifreyi ve ApiCode değerini yalnızca sunucu tarafında saklayın. Tarayıcıda çalışan koda veya mobil uygulamaya gömmeyin.
Değerleri kayıt (log) dosyalarına, hata raporlarına veya destek taleplerine yazmayın.
Bir anahtarın başkasının eline geçtiğini düşünüyorsanız panelden pasife alın veya silin ve yeni anahtar oluşturun.
Her entegrasyon için ayrı bir anahtar kullanmak, sorun olduğunda hangisinin etkilendiğini anlamayı kolaylaştırır.