Rest API Servisi
Prime Yazılım Rest API Service ile, 3rd party programlarınızı (Muhasebe, Mobile app. vs.) Prime Yazılım ile entegre edebilirsiniz. Serviste ürün, kategori, marka, siparişler ve kullanıcılar servislerine okuma ve yazma desteği sunulmaktadır. Rest API ile ulaşabileceğiniz servisler aşağıdaki gibidir.
1. Önce rest API servisi sunan sitede admin statsüsünde bir kullanıcı açılmalıdır.
Örnek : email adresi : [email protected] şifre : testapi
Sonra bu kullanıcı bir bayi grubuna atanmalı ve bu bayi grubunda "Rest API kullanabilir" işaretlenmelidir.
Son olarak ilgili panelde "XML veya Rest API Kullanabileceği IP'ler" kısmına Rest API kullanacak IP adresi eklenmelidir. Boş bıraklırısa bir IP kısıtlaması olmaz.
2. Her işlem için POST tipinde auth_email ve auth_key gönderilmelidir.
auth_email => email adresi.
auth_key şifre ve email'in tekrar şifrelenmiş halidir. Almak için önce şifre md5 olarak şifrelenir, sonra bu değer email adresi eklenerek tekrar şifrelenir.
PHP Örnek : $auth_key = md5('restapi@domainadı.com'.md5('testapi'));
3. Tüm ürünleri listelemek için /rest/products çağrılmalıdır.
4. Ürün sorgusu için /rest/products/ID/ veya /rest/products/cat/ veya /rest/products/namePath/ çağrılmalıdır.
Örnek : /rest/products/ID/132
Örnek : /rest/products/namePath/Elektronik_Televizyon
5. Kategoriye ait ürün sorgusu için /rest/products/catID/ veya /rest/products/namePath/ çağrılmalıdır. (namePath içerisikdeki / karakteri _ ile replace edilmelidir.)
Örnek : /rest/products/catID/132
Örnek : /rest/products/namePath/Elektronik_Televizyon
6. Markaya ait ürün sorgusu için /rest/products/markaID/ çağrılmalıdır.
Örnek : /rest/products/markaID/132
7. Kategorileri listelemek için /rest/list/kategori çağrılmalıdır.
8. Alt Kategorileri listelemek için /rest/list/kategori/catID veya /rest/list/kategori/namePath çağrılmalıdır. (namePath içerisikdeki / karakteri _ ile replace edilmelidir.)
9. Kategori eklemek / güncellemek için /rest/setCategory çağrılmalıdır. POST olarak kategoriye ait veriler gönderilmelidir.
POST olarak gönderilebilecek field isimleri :
ID (int) // Yazılıma ait kategori ID değeri
categoryCode (string) // Sizin tarafınızdan gönderilen, benzersiz kateori kodu.
ID ve categoryCode 'dan birinin gönderilmesi zorunludur.
parentID (int) // Yazılım kategori listesinde gelen üst kategori ID değeri.
parentCategoryCode (string) // Sizin tarafınızdan gönderilen, benzersiz üst kateoriye ait kod.
Eğer kategorinin üst kategorisi set edilecekse, parentID ve parentCode 'dan birinin gönderilmesi yeterlidir.
name (string)
İşlem sonrası ilgili kategori bilgileri XML olarak döner. Eğer kategori daha önce eklendiyse, yeni kategori eklenmez ve var olan kategori bilgileri döner.
10. Marka eklemek / güncellemek için /rest/setBrand çağrılmalıdır. POST olarak kategoriye ait veriler gönderilmelidir.
POST olarak gönderilebilecek field isimleri :
ID (int) // Yazılıma ait marka ID değeri (Gönderimezse, ve gönderilen marka yoksa yeni eklenir.)
name (string)
İşlem sonrası ilgili marka bilgileri XML olarak döner. Eğer marka daha önce eklendiyse, yeni marka eklenmez ve var olan marka bilgileri döner.
11. Ürün eklemek / güncellemek için /rest/setProduct çağrılamlıdır. POST olarak ürüne ait veriler gönderilmelidir. Yeni bir ürün eklenmeden önce, kategori ve marka eklenmiş ve ilgili ID'lerin elimizde olması gerekir.
POST olarak gönderilebilecek field isimleri :
ID (int) // Yazılıma ait ürün ID değeri
productCode (string) // Sizin tarafınızdan gönderilen, benzersiz ürün kodu.
ID ve categoryCode 'dan birinin gönderilmesi zorunludur.
catID (int), // kategori kodu değil, yazılıma ait kategori ID değeri olmalıdır.
virtualCatIDs (string), // kategori kodu değil, yazılıma ait kategori ID değerleri olmalıdır. (ÖR : 12,22,33,44)
markaID (int), // marka adı değil, yazılıma ait marka ID değeri olmalıdır.
name (string),
listeDetay (string),
onDetay (string),
detay (text),
resim1 (text) ... resim5 (text), // Bir ürüne 5 adet resin eklenebilir. Resim download URL adresi girilmelidir.
veya
resim_base64_1 (base64) ... resim_base64_5 (base64), // Şeklinde base64 olarak resimler upload edilebilir.
stok (float),
kdv (int), // %18 için 18 gönderilmelidir.
fiyat (float),
piyasafiyat (float),
fiyatBirm (string),
garanti (int), // Garanti ay süresi.
desi (float),
gtin (string) // GTIN veya EAN veya UPC veya ISBN gibi barkod bilgisi.
Bu bilgiler ek olarak filtre bilgilerini gönderebilirsiniz. Örneğin filterName_1 : Yazar , filterValue_1 : Orhan Kemal
filterName_1 (string),
filterValue_1 (string),
... filterName_[1-10] , filterValue_[1-10]
12. Ürün fiyat ve stok güncellemek için /rest/setProduct/priceAndStock çağrılamlıdır. POST olarak ürüne ait veriler gönderilmelidir.
POST olarak gönderilebilecek field isimleri :
ID (int) // Yazılıma ait ürün ID değeri. Zorunludur.
stok (int),
kdv (int), // %18 için 18 gönderilmelidir.
fiyat (float),
piyasafiyat (float),
fiyatBirim (string)
13. Ürün varyant güncellemek için /rest/setProduct/variant çağrılamlıdır. POST olarak ürüne ait veriler gönderilmelidir. Yazılım altyapısında 2 'li varyasyona ait X-Y kombinasyon desteği vardı.
Örnek : Kazan ürününe ait XL bedeni ve Kırmızı renke sahip varyasyonu.
POST olarak gönderilebilecek field isimleri :
ID (int) // Yazılıma ait ürün ID değeri. Zorunludur.
varStock (floar), // Varyasyon Stok Adet
varCode (string), // Varyasyon Stok Kodu.
varBarcode (string), // Varyasyon Barkodu.
varResim (string), // Varyasyon Resmi (URL Adresi).
var1_name (string), // Örnek : Beden
var2_name (string), // Örnek : Renk
var1_var (string), // Örnek XL
var2_var (string), // Örnek Kırmızı
var1_fark (float), // Fiyat farkı.
var2_fark (float), // Fiyat farkı.
14. Ürün filtre güncellemek için /rest/setProduct/filter çağrılamlıdır. POST olarak ürüne ait veriler gönderilmelidir.
POST olarak gönderilebilecek field isimleri :
ID (int) // Yazılıma ait ürün ID değeri. Zorunludur.
title (string), // Örnek : Ekran Çözünürlüğü
str (sring), // Örnen Full HD
15. Siparişlere ait sorgu için /rest/orders/date/<başlangış tarih="">_<bitiş tarih=""> çağrılmalıdır.
Örnek : /rest/orders/date/2017-12-31_2019-12-31
16. Tek siparişe ait sorgu için /rest/orders/no/ çağrılmalıdır.
Örnek : /rest/orders/no/158238365
17. Duruma göre siparişleri listelemek için /rest/orders/durum/ çağrılmalıdır.
Örnek : /rest/orders/durum/2
Durum No : 1= Ödeme Onay Bekliyor. 2= Siparis Onaylandı / Hazırlanıyor., 51= Siparişiniz Kargoya Teslim Edildi., 81= Teslimat Yapıldı., 89= Değişim Talebi Alındı., 90= İptal Talebi Alındı.
18. Siparişe ait durum değiştirmek için /rest/updateOrder/no/ çağrılmalıdır.
Örnek : /rest/updateOrder/no/158238365/51
POST olarak gönderilebilecek field isimleri :
durum (int),
kargoTarih (date),
kargoFirma (int),
kargoSeriNo (string),
kargoURL (string)
Durum No : 1= Ödeme Onay Bekliyor. 2= Siparis Onaylandı / Hazırlanıyor., 51= Siparişiniz Kargoya Teslim Edildi., 81= Teslimat Yapıldı., 89= Değişim Talebi Alındı., 90= İptal Talebi Alındı.
19. Kargo Firmalarını listelemek için /rest/list/kargo çağrılmalıdır.
20. Bannerları listelemek için /rest/list/banner çağrılmalıdır.
21. Slider resimlerini listelemek için /rest/list/slider çağrılmalıdır.
22. Şehirleri listelemek için /rest/list/city çağrılmalıdır.
23. Semtleri listelemek için /rest/list/town çağrılmalıdır.
24. Kullanıcıları listelemek için /rest/users çağrılmalıdır.
Tek bir kullanıcı çağırmak için /rest/users/ID/ çağrılmalıdır.
Örnek : /rest/users/ID/132
25. Kullanıcı eklemek veya güncellemek için setUser çağrılmalır.
Örnek : /rest/setUser
POST olarak gönderilebilecek field isimleri :
email (string), // Kullanıcı e-posta değeri zorunludur. Eğer bu e-posta varsa kullanıcı bilgileri güncellenir. Yoksa yeni kullanıcı eklenir.
password (string), // Kullanıcı şifresi. md5 hash ile veri tabanında saklanır.
name (string),
lastname (string),
birtdate (date),
tckNo (int),
vergiDaire (string),
vergiNo (string),
efatura (bool),
city (int), // iller tablosundaki plaka kodu
semt (int), // ilçeler tablosundaki semt ID değeri
address (string),
ceptel (string), // XXX-YYYYYYY formatında telefon girişi
istel (string), // XXX-YYYYYYY formatında telefon girişi
evtel (string), // XXX-YYYYYYY formatında telefon girişi
ebulten (bool),
ebultensms (bool),
26. Adresleri listelemek için /rest/list/address/ çağrılmalıdır.
Örnek : /rest/list/address/1
27. Kullanıcı eklemek veya güncellemek için setUser çağrılmalır.
Örnek : /rest/setAddress
POST olarak gönderilebilecek field isimleri :
userID (int), // Kullanıcı ID değeri zorunludur.
addressID (int), // Address ID varsa güncellenir, yoksa yeni eklenir.
title (string),
address (string),
city (int), // iller tablosundaki plaka kodu
semt (int), // ilçeler tablosundaki semt ID değeri
tckNo (int),
vergiDaire (string),
vergiNo (string)
28. SMS göndermek için /rest/sendSMS/no/ çağrılmalıdır.
Örnek : /rest/sendSMS/no/158238365
POST olarak gönderilebilecek field isimleri :
msg (string)
29. HTML olarak taksit ekranı /rest/html/taksit/ ile çağrılmalıdır.
Örnek : /rest/html/taksit/190
30. Kullanıcıya favori ürün eklemek için setFavorite çarılmalıdır.
Örnek : /rest/setFavorite
POST olarak gönderilebilecek field isimleri :
userID (int), // Kullanıcı ID değeri zorunludur.
urunID (int), // Ürün ID değeri zorunludur.
Başaırılı durumda success, daha önce zaten eklenmiş gibi başarısız durumlarda ERROR yanıtı döner.
31. Kullanıcının favori ürününü kaldırmak için removeFavorite çarılmalıdır.
Örnek : /rest/removeFavorite
POST olarak gönderilebilecek field isimleri :
userID (int), // Kullanıcı ID değeri zorunludur.
urunID (int), // Ürün ID değeri zorunludur.
Başaırılı durumda success, ürünün zaten favorilerde olmaması gibi başarısız durumlarda ERROR yanıtı döner.
32. Bir promosyon kodu eklemek için setPromotion çarılmalıdır.
Örnek : /rest/setPromotion
POST olarak gönderilebilecek field isimleri :
code (string), // Promosyon kodu zorunludur.
min (float), // Promosyon kodu kullanabilmek için asgari sipariş tutarı.
discount (float), // İndirim oranı. %10 indirim için 0.1 gönderilmelidir.
amount (float), // İndirim tutarı. 10 TL indirim için 10 gönderilmelidir.
tarih (date), // Promosyon kodu son kullanım tarihi. Ör : 2020-12-31
Başaırılı durumda success, kodun zaten favorilerde olmaması gibi başarısız durumlarda ERROR yanıtı döner.
33. Sepet görüntülemek için /rest/basket/view/<sipariş numarası=""> URL'ini kullanabiliriz.
Örnek : /rest/basket/view/123456789
34. Sepete ürün eklemek için /rest/basket/insert/<sipariş numarası=""> URL'ini kullanabiliriz.
Örnek : /rest/basket/insert/123456789
POST olarak gönderilebilecek field isimleri :
urunID (int), // Sepete eklenecek ürün ID
adet (float), // Eklenecek ürün adet.
userID (int), // Eklenecek kullanıcı ID
ozellik1detay (string), // Eklenecek varyasyon detay. Buradaki 1 yerine varyasyon sırasını girebiliriz. Ör : ozellik3detay
35. Sepetten ürün silmek için /rest/basket/remove/ URL'ini kullanabiliriz. sepet ID'i sepet view ile gelen XML 'de görebilriz.
Örnek : /rest/basket/remove/123456789
POST olarak gönderilebilecek field isimleri :
lineID (int), // Silinecek Sepet ID
36. Sepetten ürün adet güncellemek için /rest/basket/update/ URL'ini kullanabiliriz. sepet ID'i sepet view ile gelen XML 'de görebilriz.
Örnek : /rest/basket/update/123456789
POST olarak gönderilebilecek field isimleri :
lineID (int), // Güncellenecek Sepet ID
adet (float), // Güncellenecek adet
37. Sepet'i boşaltmak için /rest/basket/clean/<sipariş numarası=""> URL'ini kullanabiliriz.
Örnek : /rest/basket/clean/123456789
38. Sipariş submit etmek için /rest/setOrder çağrılmaldır.
Örnek : /rest/setOrder
POST olarak gönderilebilecek field isimleri :
[Sipariş]
no (int), // 9 habeli benzersiz sipariş numarası
name (string),
lastname (string),
birtdate (date),
tckNo (int),
vergiDaire (string),
vergiNo (string),
city (int), // iller tablosundaki plaka kodu
semt (int), // ilçeler tablosundaki semt ID değeri
address (string),
city2 (int), // Fatura için iller tablosundaki plaka kodu
semt2 (int), // Fatura için ilçeler tablosundaki semt ID değeri
address2 (string), // Fatura için adres
ceptel (string), // XXX-YYYYYYY formatında telefon girişi
istel (string), // XXX-YYYYYYY formatında telefon girişi
evtel (string), // XXX-YYYYYYY formatında telefon girişi
kargoTutar (float), // Sipariş kargo tutarı
toplamTutarTL (float), // Sipariş toplam tutar TL,
odemeTipi (string), // Ödeme Tipi
[Sepet]
urunID_1 (int), // Sepete eklenecek ürün ID
urunName_1 (string), Eğer veri tabanındaki adından farklıysa eklenecek ürün Adı,
urunFiyat_1 (string), TL Cinsinde satış fiyatı,
urunAdet_1 (float), // Eklenecek ürün adet.
ozellik1detay_1 (string), // Eklenecek varyasyon detay. Buradaki 1 yerine varyasyon sırasını girebiliriz. Ör : ozellik3detay
urunID_2 (int), // Sepete eklenecek ürün ID
urunName_1 (string), Eğer veri tabanındaki adından farklıysa eklenecek ürün Adı,
urunFiyat_2 (string), TL Cinsinde satış fiyatı,
urunAdet_3 (float), // Eklenecek ürün adet.
ozellik1detay_2 (string), // Eklenecek varyasyon detay. Buradaki 1 yerine varyasyon sırasını girebiliriz. Ör : ozellik3detay
...
Tek sorguda azami 50 adet farklı ürün sepete eklenebilir.
39. Sipariş durum gümcellemek için /rest/setOrderStatus çağrılmaldır.
Örnek : /rest/setOrderStatus
POST olarak gönderilebilecek field isimleri :
[Sipariş]
no (int), // 9 habeli benzersiz sipariş numarası
status (int), // Sipariş durum değeri. 1- Onay bekliyor 2- Onaylandı 51-Kargoya teslim edildi. 81- Sipariş teslim edildi. 91- İptal edildi.</sipariş></sipariş></sipariş></bitiş></başlangış>