İçindekiler
Version Bilgisi
MYSOFT IYS Api 2.12 sürümü
Sürüm Tarihi: 17.05.2021
Sürüm Notları
ConsentDataModel sınıfına Özel Değer girilmesi için specialValue alanı eklendi
MYSOFT IYS Api 2.11 sürümü
Sürüm Tarihi: 01.02.2021
Sürüm Notları
Çoklu İleti gönderimi(SendConsentBatch) metoduna isSaveSuccessData alanı eklenmiştir.
Bu alan ile gönderimde hatalı kayıtlar çıkarsa tüm kayıtların geri dönmesi değil başarılı olanların içeri kaydedilmesi ve sadece hatalı kayıtların güncellenmesi sağlanmaktadır.
Genel Hata Kodları(errorCode):
HM400 - işlem hatası
HM404 - kayıt bulunamadı
HM422 - veri format ve şema hatası
MYSOFT IYS Api 2.10 sürümü
Sürüm Tarihi: 11.01.2021
Sürüm Notları
Webhook ve geçmişe yönelik kayıt sorgulama servislerine source değerleri eklenmiştir.
"IYS_3338","IYS_CM", "IYS_WEB", "IYS_MOBIL","IYS_KISA_LINK"
MYSOFT IYS Api 2.9 sürümü
Sürüm Tarihi: 23.12.2020
Sürüm Notları
Alıcı bilgileri ile durum sorgulama yöntemine kayıt bulunamaması durumunda hata kodu dönüşü eklenmiştir. Kayıt bulunmadı hatası için Hata Kodu:HM404
MYSOFT IYS Api 2.8 sürümü
Sürüm Tarihi: 14.12.2020
Sürüm Notları
Kullanıcı Adı ve Şifre ile Token Alma yöntemi güncellendi.
MYSOFT IYS Api 2.7 sürümü
Sürüm Tarihi: 30.11.2020
Sürüm Notları
Geçmişe Dönük Kayıtları Sorgulama metodunun çağrı parametreleri güncellendi.
Alıcı Bilgileri İle Durum Sorgulama metodunun çağrı parametreleri güncellendi.
MYSOFT IYS Api 2.6 sürümü
Sürüm Tarihi: 21.11.2020
Sürüm Notları
Çoklu IYS Gönderim Durum sorgulama metoduna ilgili işlem anahtarına ait tüm kayıtları dönmeye olanak sağlayan isSendAllData parametresi eklenmiştir.
MYSOFT IYS Api 2.5 sürümü
Sürüm Tarihi: 10.11.2020
Sürüm Notları
Alıcı Bilgileri İle Durum Sorgulama metodunun çağrı adresi güncellenmiştir.
Geçmişe Dönük Kayıtları Sorgulama adı altında yeni metod eklenmiştir.
MYSOFT IYS Api 2.4 sürümü
Sürüm Tarihi: 11.10.2020
Sürüm Notları
Hata kodları için errorCode alanı eklenmiştir.
Webhook objesi eklenmiştir.
Metod: 'Webhook'
MYSOFT IYS Api 2.3 sürümü
Sürüm Tarihi: 04.09.2020
Sürüm Notları
Çoklu İleti Gönderimi
ve
Çoklu İleti Gönderimi İşleminin Sonucunu Sorgulama
çağrıları güncellenmiştir.
Çoklu İleti Gönderiminin Durumlarını Sorgulama adı altında yeni çağrılar eklenmiştir.
Bu Çağrılar;
-
Başarılı Kayıtlar
-
Hatalı Kayıtlar
-
Güncellenen Kayıtlar
-
İşlem Yapılmayan Kayıtlar
Ayrıca çoklu ileti eklemenin IYS gönderim durumlarının kontrol edildiği 1 adet metod daha ekledik.
Bu metod IYS’ye gönderim durumlarınıda dönmektedir.
-
Çoklu IYS’ye Gönderim Sorgulama
Alıcı Bilgileri İle Durum Sorgulama adı altında yeni çağrı eklenmiştir.
Alıcı bilgisinin Mysoft sistemindeki durumlarını kontrol eden metoddur.
MYSOFT IYS Api 2.2 sürümü
Sürüm Tarihi: 11.08.2020
Sürüm Notları
Tekli ileti ekleme çağrısına IYS ye direk gönderim ile ilgili parametre eklenmiştir.
Parametre: 'isNotAutoSendIYS'
MYSOFT IYS Api 2.1 sürümü
Sürüm Tarihi: 01.08.2020
Giriş
Bu dökümanda Mysoft IYS API
metodları ve çağrı yöntemleri anlatılmaktadır.
MYSOFT IYS API adresler:
TEST: https://iysapitest.mysoft.com.tr/
CANLI: https://iysapi.mysoft.com.tr/
Authentication
OAuth 2.0 (Kimlik Doğrulama Yöntemi)
MYSOFT IYS
uygulaması OAuth 2.0 Kimlik doğrulama yöntemini kullanır.
İlk olarak
Bizden alacağınız Kullanıcı Adı ve Şifre bilgileri ile Servisimize istek atarak
Token alıp sonra bu Token’i istek atarken Headers bilgisine geçerek
kullanabileceksiniz. Token türü Bearer’ dir.
Kullanıcı
Adı ve Şifre ile Token Alma
Bizden aldığınız
kullanıcı adı ve şifreyi aşağıdaki metoda gösterilen şekilde Request atıp
servis çağrılarında kullanabileceğiniz Token’i elde edebilirsiniz.
//Metod POST
//
https://iysapitest.mysoft.com.tr/
oauth/token
C# Rest Client
var client = new RestClient("https://iysapitest.mysoft.com.tr/oauth/token");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("username", "username");
request.AddParameter("password", "password");
request.AddParameter("grant_type", "password");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
Jquery
var settings = {
"url": "https://iysapitest.mysoft.com.tr/oauth/token",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
"data": {
"username": "username",
"password": "password",
"grant_type": "password"
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
Response (Sonuç)
Modelleri
Tekil Sonuç Dönen Model (QueryResultModel<T>)
Servis isteklerinde(request) sonuç(response) olarak dönen tekli
değerlerde kullanılan model tanımlamasıdır. Generic type <T> parametresi
alır. Bu modelin içinde atılan isteğin sonucunu belirten ‘succeed’ parametresi
bulunur.
Bu parametre ‘true’ ise istek başarılı olur ve istenilen veriler
modelin içindeki ‘data’ parametresinin içinde gelir
. Ama gelen sonuç ‘false’
ise istek başarısız demektir ve isteğin neden başarısız olduğunun açıklamasını
yapan ‘message’ parametresi dolu gelir. Bu parametrenin içeriğinden hatanın
nedenini öğrenebiliriz.
Public class QueryResultModel<T>
{
public T data { get; set; }
public bool succeed { get; set; }
public string message { get; set; }
public string errorCode { get; set; }
}
Çoklu Sonuç Dönen List Model (QueryResultList<T>)
Tekli Sonuç Dönen Model ile aynı mantıkta çalışır ama data
parametresine liste halinde değer döner.
Public class QueryResultList<T>
{
public List<T> data { get; set; }
public bool succeed { get; set; }
public string message { get; set; }
public string errorCode { get; set; }
}
Örnek
Kontrol
var result = OrnekServisFonksiyon();
//Servisten gelen response
alma
if(result.succeed){ //succeed parametresi kontrol
sonucOku(result.data); //true ise ‘data’ parametresi içinde gelen veriyi okuma
}
else{
hataYazdir(result.message); //false ise hatayı okuma
}
Marka
Listeleme
Bu metot ile hesabınızın
altında bulunan markalarınızın isim ve kod bilgilerine ulaşırsınız.
Metod Erişim
Bilgileri
//Erişim Metodu (Get)
//Test Ortamı:
https://iysapitest.mysoft.com.tr/api/IYSConsent/IYSBrands
İstek
(Request) Atarken Parametreler
Sadece
Request’in Header’ına eklenen token bilgileri yeterlidir
Gelen
Cevap (Response) Parametreler
(Çoklu Sonuç Dönen List Model)
|
Response Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
Integer
|
IYS Marka Kodu
|
|
stats
|
Stats
|
Bu bilgi bayi sayısını ve durum istatistiğini verir.
|
|
name
|
String
|
Marka ismi
|
|
master
|
Boolean
|
Markanın ana marka olup olmadığı bilgisi
(True yada False)
|
Stats
Model
|
Stats
|
|
Parametre Adı
|
Parametre Tipi
|
Açıklama
|
|
consents
|
Consents
|
Toplam onaylı izin, ret izin ve Toplam izin sayısını
belirten model
|
|
retailers
|
Retailers
|
Markanın altında kayıtlı toplam bayi sayısı
|
Consents
Model
|
Consents
|
|
Parametre Adı
|
Parametre Tipi
|
Açıklama
|
|
approval
|
Integer
|
Toplam onaylı izin sayısı
|
|
rejection
|
Integer
|
Toplam ret izin sayısı
|
|
total
|
Integer
|
Toplam izin sayısı
|
Retailers
Model
|
Retailers
|
|
Parametre Adı
|
Parametre Tipi
|
Açıklama
|
|
total
|
Integer
|
Markanın altında kayıtlı toplam bayi sayısı
|
Örnek
İstek ve Cevap
İstek
(Request)
(GET)
//GET {Mysoft IYS Api Adresi}/api/IYSConsent/IYSBrands
Cevap
(Response)
Başarılı
{[
{
"brandCode": 1232322,
"stats": {
"consents": {
"approval": 22,
"rejection": 0,
"total": 22
},
"retailers": {
"total": 4
}
},
"name": "Test Marka 1",
"master": true
},
{
"brandCode": 123e22,
"stats": {
"consents": {
"approval": 20,
"rejection": 0,
"total": 69
},
"retailers": {
"total": 40
}
},
"name": "Test Marka 2",
"master": false
}
]}
Başarısız
{
"data" : null,
"succeed": false,
"message":"Hata Mesajı"
}
Tekli
İleti Gönderimi
Tekli ileti
gönderimi için kullanılır.
Metod Erişim
Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSConsent/SendConsent
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
consentData
|
ConsentDataModel
|
Eklenen Veri Modeli (Tekil)
|
|
isNotAutoSendIYS
|
Boolean
|
True ise sadece MYSOFT IYS'ye kaydeder. False ise IYS'ye kaydeder ve MYSOFT IYS'de günceller.
|
ConsentDataModel
|
ConsentDataModel
|
|
Parametre Adı
|
Parametre Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın
sistemde kayıtlı telefon numarası veya e-posta bilgisidir. Eposta adresleri
284, telefon numaraları 15 karakterden daha uzun olamaz.
Telefon numarası +905813334455 formatına uygun olmalıdır.
([+][country code][area code][local phone number]) (+905555555555)
|
|
recipientType
|
String (ENUM)
|
Sadece 2 değer alır.
("BIREYSEL", "TACIR"). Tacir durumunu gösteren bilgidir.
(Varsayılan değer: BIREYSEL)
|
|
type
|
String (ENUM)
|
Sadece 3 değer alır. ("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu belirlediği tarihtir.
Alıcı tipi TACIR ise eklenmesi zorunlu değildir. Örnek Format (2018-02-10
09:30:00)
|
|
source
|
String (Enum)
|
Sadece 12 değer alır. ("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM")
|
|
status
|
String (Enum)
|
Sadece 2 değer alır ("ONAY",
"RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye İYS tarafından tekil
olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS tarafından tekil olarak
atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
Gelen
Cevap (Response) Parametreler
(Tekli Sonuç Dönen Model)
İstek
(Request) atarken doldurduğumuz consentData parametresi, ConsentDataModel
formatında gelir. Sonra bu modeldeki recipient, recipientType ve type
alanlarını kullanarak eklemenin sonucu sorgulanır.
|
Response Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
type
|
String (ENUM)
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu
belirlediği tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK",
"HS_2015", "HS_ATM")
|
|
status
|
String (Enum)
|
("ONAY", "RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS
tarafından tekil olarak atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
Örnek
İstek ve Cevap
İstek
(Request)
//{Mysoft IYS Api Adresi}/api/IYSConsent/SendConsent
{
"brandCode":"5565656556",
"isNotAutoSendIYS": true,
"consentData": {
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer"
}
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": {
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer"
},
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Tekli
İleti Gönderimi İşleminin Sonucunu Sorgulama
Tekli ileti
gönderiminin sonucunu sorgulamak için kullanılır.
Metod Erişim
Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSConsent/ConsentStatus
İstek
(Request) Atarken Parametreler
Yukarıda
anlattığımız Tekli İleti Gönderimi İşlemi ’nden Gelen Response bilgisi ile
parametreleri dolduruyoruz
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon
numarası veya e-posta bilgisidir.
|
|
recipientType
|
String
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
type
|
String
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
isQueryFromIYS
|
String
|
True ise IYS’ye kaydedip MYSOFT
IYS’deki bilgileri güncelliyor, False ise sadece MYSOFT IYS’ye kaydediyor
|
Gelen
Cevap (Response) Parametreler
(Tekli Sonuç Dönen Model)
İleti Gönderimi İşleminin sonucu Tekli Sonuç Dönen Modelin ‘succeed’
parametresine göre öğrenilir
|
Response Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
consentDate
|
String (date-time)
|
İlgili marka'nın müşterisinin
(vatandaşın) ileti için izin verdiği ilk tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon
numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
status
|
String (Enum)
|
("ONAY", "RET")
Vatandaşın izin durumunu gösterir.
|
|
type
|
String (ENUM)
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM")
|
|
retailerAccessCount
|
Integer
|
İzne erişimi bulunan bayi sayısını
ifade eder.
|
|
retailerTitle
|
String
|
İzne erişimi bulunan bayi ismini
ifade eder.
|
|
retailerCode
|
Integer
|
İzin alınmasına aracılık eden
bayiye İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
Örnek
İstek ve Cevap
İstek
(Request)
(Post)
//{Mysoft IYS Api Adresi}/api/IYSConsent/ConsentStatus
{
"brandCode":"5565656556",
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"isQueryFromIYS": true
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": {
"consentDate" : "2018-02-10 09:30:00",
"recipient" : "+905555555555",
"recipientType" : "BIREYSEL",
"status" : "ONAY",
"type" : "MESAJ",
"source" : "HS_FIZIKSEL_ORTAM",
"retailerAccessCount" : 35,
"retailerTitle" : "Firma LTD.",
"retailerCode" : 1553855
},
"message": null
}
Başarısız
{
"succeed" : false,
"data" : null,
"message" : "Hata Mesajı"
}
Çoklu İleti Gönderimi
Çoklu İleti Gönderimi için kullanılır. ConsentData
Parametresine liste halinde ConsentDataModel
eklenir. Eğer
istek başarılı ise geriye String veri tipinde benzersiz anahtar (GUID) ve ConsentDataInfoModel
döner. Bu dönen anahtar(GUID) ile Çoklu İleti Gönderimi işleminin sonucu
sorgulanır. ConsentDataInfoModel üzerinde ise gönderilen veriler içinde hata
var ise hata mesajını gönderilen veri ile birlikte döner. Hatalı kayıt olması durumunda tüm kayıtlar iptal edilir ve geri dönülür. Tüm kayıtların başarılı olması durumunda succeed:true ve kayıt listesi boş olarak dönülür. Çoklu ileti gönderiminde 1000 adet kayıt kabul edilmektedir.
Metod Erişim Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSConsent/SendConsentBatch
İstek (Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
consentData
|
Generic Listenin İçinde ConsentDataModel
|
Çoklu eklemek için
bi generic listeye bu modeli birden fazla ekleyebilirsiniz
|
|
isSaveSuccessData
|
bool
|
Başarılı kayıtları dönmeden kaydet. Servis bu parametre true geçilir ise Hatalı kayıtlar olması durumunda başarılı kayıtları insert eder ve hatalı kayıt varsa geri dönüş değerinde sadece hatalı kayıtları döner.
|
ConsentDataModel
|
ConsentDataModel
|
|
Parametre Adı
|
Parametre Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın
sistemde kayıtlı telefon numarası veya e-posta bilgisidir. Eposta adresleri
284, telefon numaraları 15 karakterden daha uzun olamaz.
Telefon numarası +905813334455 formatına uygun olmalıdır.
([+][country code][area code][local phone number]) (+905555555555)
|
|
recipientType
|
String (ENUM)
|
Sadece 2 değer alır.
("BIREYSEL", "TACIR"). Tacir durumunu gösteren bilgidir.
(Varsayılan değer: BIREYSEL)
|
|
type
|
String (ENUM)
|
Sadece 3 değer alır. ("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu belirlediği tarihtir.
Alıcı tipi TACIR ise eklenmesi zorunlu değildir. Örnek Format (2018-02-10
09:30:00)
|
|
source
|
String (Enum)
|
Sadece 12 değer alır. ("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM")
|
|
status
|
String (Enum)
|
Sadece 2 değer alır ("ONAY",
"RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye İYS tarafından tekil
olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS tarafından tekil olarak
atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
Gelen Cevap (Response) Parametreler
(Tekli
Sonuç Dönen Model)
Çoklu İleti Gönderiminin sonucu başarılı ise ‘succeed’
alanı True döner ve Çoklu İleti Gönderimi başarılı ise
String
veri tipinde benzersiz anahtar (GUID) döner. Bu dönen anahtar ile Çoklu İleti
Gönderimi işleminin sonucu sorgulanır. Buna ek olarak
ConsentDataInfoModel üzerinde ise gönderilen veriler içinde
hata var ise hata mesajını gönderilen veri ile birlikte döner.
|
Response
Parametreleri (ConsentDataInfoModel)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
consentDate
|
String (date-time)
|
İlgili marka'nın müşterisinin
(vatandaşın) ileti için izin verdiği ilk tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon
numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
status
|
String (Enum)
|
("ONAY",
"RET") Vatandaşın izin durumunu gösterir.
|
|
type
|
String (ENUM)
|
("ARAMA", "MESAJ",
"EPOSTA") Vatandaşın izin verdiği iletişim kanalıdır.
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK",
"HS_2015", "HS_ATM")
|
|
retailerAccessCount
|
Integer
|
İzne erişimi bulunan bayi sayısını
ifade eder.
|
|
retailerTitle
|
String
|
İzne erişimi bulunan bayi ismini ifade
eder.
|
|
retailerCode
|
Integer
|
İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
portalStatusText
|
String
|
Portal kayıt durum açıklaması
|
|
portalStatus
|
Integer
|
Portal kayıt durumu
|
|
errorMessage
|
String
|
Hata mesajı
|
|
errorCode
|
String
|
Hata Kodu
|
Örnek İstek ve Cevap
İstek
(Request)
(POST)
//{Mysoft IYS Api Adresi}/api/IYSConsent/SendConsentBatch
{
"brandCode":"5565656556",
"consentData": [
{
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer"
},
{
"recipient": "eposta@mail.com",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer"
}
]
}
Cevap (Response)
Başarılı
{
"succeed": true,
"data": {
"transctionGuid" : "638bfa83-c188-47a3-81e6-4aef718d27c5",
"consentList" : [
{
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"portalStatusText" : "Hatalı telefon bilgisi",
"portalStatus" : 1,
"errorMessage" : "Telefon numarası hatasız girilmelidir"
"errorCode" : "H10011"
},
{
"recipient": "eposta@mail.com",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"portalStatusText" : "Hatalı telefon bilgisi",
"portalStatus" : 1,
"errorMessage" : "Telefon numarası hatasız girilmelidir"
"errorCode" : "H10011"
}
]
}
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Çoklu İleti Gönderimi İşleminin Sonucunu Sorgulama
Çoklu İleti Gönderimi İşleminin sonucunda String
veri tipinde GUID geliyordu. Şimdi bu GUID’i
kullanarak işlem sonucunu sorgulama yapacağız.
Metod
Erişim Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSConsent/ConsentBatchStatus
İstek (Request) Atarken Parametreler
|
Request
Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
transctionGuid
|
String
|
Çoklu İleti Gönderimi İşleminin Başarılı Olması
Sonucunda Dönen GUID
|
Gelen Cevap (Response)
Parametreler
(Çoklu Sonuç
Dönen List Model)
Bu metodun toplu gönderimin başarılı olması ile elde edilen transctionGuid bazında sonuç dönmektedir. Bu metod her toplu gönderim işlendikce
üzerindeki ana bilgileri güncellemektedir. Bu durumlar her zaman kontrol
edilebilir.
|
Response
Parametreleri (Tekli Sonuç Modeli)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
transctionGuid
|
String
|
Çoklu İleti Gönderimi İşleminin Başarılı Olması
Sonucunda Dönen GUID
|
|
batchStatus
|
Integer
|
Çoklu gönderimin hangi aşamada olduğunu gösterir
(1-Bekliyor, 2-İşleniyor, 3-İşlendi, 4-İşlenirken Hata)
|
|
batchStatusText
|
String
|
batchStatus
alanından gelen rakamların Metin karşılığı
|
|
recordCount
|
Integer
|
Aktarılan kayıt sayısını ifade etmektedir
|
|
insertedRecordCount
|
Integer
|
içeri başarılı olarak aktarılan kayıt sayısıdır
|
|
updatedRecordCount
|
Integer
|
aktarım sırasında eski kayıtları güncelleyen kayıt
sayısıdır
|
|
errorRecordCount
|
Integer
|
hatalı olarak aktarılan kayıt sayısıdır
|
|
isUsedBeforeRecordCount
|
Integer
|
daha önce aktarılan ve güncelleme yapılmayan kayıt
sayısıdır
|
Örnek İstek ve Cevap
İstek (Request)
(POST)
//{Mysoft IYS Api Adresi}/api/IYSConsent/ConsentBatchStatus
{
"brandCode" : "6665554",
"transctionGuid": "638bfa83-c188-47a3-81e6-4aef718d27c5"
}
Cevap (Response)
Başarılı
{
"succeed":
true
,
"data": {
"transctionGuid" : "638bfa83-c188-47a3-81e6-4aef718d27c5",
"batchStatus" : 1,
"batchStatusText" : "Bekliyor",
"recordCount" : 4,
"insertedRecordCount" : 1,
"updatedRecordCount" : 1,
"errorRecordCount" : 1,
"isUsedBeforeRecordCount" : 1
},
"message":
null
}
Başarısız
{
"succeed":
false
,
"data":
null
,
"message": "Hata Mesajı"
}
Çoklu İleti
Gönderiminin Durumlarını Sorgulama
Çoklu İleti
Gönderimi İşleminin sonucunda String veri tipinde dönen GUID bilgisine göre
çoklu gönderimlerin durumlarını sorgulama yapacağız. Bu işlemler üzerine 4 tane
sorgulama türümüz olacak.
Bu Metodlar;
1.
Başarılı Kayıtlar
2.
Hatalı Kayıtlar
3.
Güncellenen Kayıtlar
4.
İşlem Yapılmayan Kayıtlar
Ayrıca çoklu
ileti eklemenin IYS gönderim durumlarının kontrol edildiği 1 adet metodumuz
daha vardır.Bu metod IYS’ye gönderim durumlarınıda dönmektedir.
Bu Metod;
1.
Çoklu IYS’ye Gönderim Sorgulama
Başarılı
Kayıtlar
Toplu olarak
yapılan api çağrısı sonucunda başarılı olarak MYSOFT sistemine kaydedilen
kayıtların listelendiği metoddur. Başarılı işlenen kayıtlar geri dönülür.
Metod
Erişim Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSConsent/ConsentBatchStatusSuccess
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
transctionGuid
|
String
|
Çoklu İleti Gönderimi İşleminin
Başarılı Olması Sonucunda Dönen GUID
|
Gelen Cevap
(Response) Parametreler (Çoklu Sonuç Dönen Model)
Başarılı işlenen
kayıtlar geri dönülür.
|
Response
Parametreleri (Liste
Halinde Gelir)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
type
|
String (ENUM)
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu
belirlediği tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM")
|
|
status
|
String (Enum)
|
("ONAY", "RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS
tarafından tekil olarak atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
Örnek İstek
ve Cevap
İstek
(Request)
(Post)
//{Mysoft IYS Api Adresi}/api/IYSConsent/ConsentBatchStatusSuccess
{
"brandCode" : "6665554",
"transctionGuid": "638bfa83-c188-47a3-81e6-4aef718d27c5"
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": [
{
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer"
},
{
"recipient": "eposta@mail.com",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer"
}
],
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Hatalı Kayıtlar
Toplu olarak
yapılan api çağrısı sonucunda hatalı kayıtların listelendiği metoddur. Hatalı
kayıtlar ve hata mesajları dönülür.
Metod
Erişim Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: {Mysoft Api Adresi}/api/IYSConsent/ConsentBatchStatusError
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
transctionGuid
|
String
|
Çoklu İleti Gönderimi İşleminin
Başarılı Olması Sonucunda Dönen GUID
|
Gelen Cevap
(Response) Parametreler (Çoklu Sonuç Dönen Model)
Hatalı kayıtların
listesi döner ve dönen listenin içindeki kayıtların üzerinde gelen ‘errorMessage’
alanı, o kaydın neden hatalı olduğunu belirten mesaj döndürür.
|
Response
Parametreleri (Liste
Halinde Gelir)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
type
|
String (ENUM)
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu
belirlediği tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK",
"HS_2015", "HS_ATM")
|
|
status
|
String (Enum)
|
("ONAY", "RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS
tarafından tekil olarak atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
|
errorMessage
|
String
|
kaydın neden hatalı olduğunu
belirten mesaj döndürür.
|
|
errorCode
|
String
|
kaydın neden hatalı olduğunu
belirten hata kodunu döndürür.
|
Örnek İstek
ve Cevap
İstek
(Request)
(Post)
//{Mysoft IYS Api Adresi}/api/IYSConsent/ConsentBatchStatusError
{
"brandCode" : "6665554",
"transctionGuid": "638bfa83-c188-47a3-81e6-4aef718d27c5"
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": [
{
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer",
"errorMessage" : "Telefon numarası hatalı"
"errorCode" : "H10011"
},
{
"recipient": "eposta@mail.com",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer",
"errorMessage" : "Mail adresi hatalı"
"errorCode" : "H10012"
}
],
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Güncellenen
Kayıtlar
Toplu olarak
yapılan api çağrısı sonucunda güncellenen kayıtların listelendiği metoddur. Bu
metodda kayıtların güncelleme işlemi öncesi halleri geri dönülür.
Metod
Erişim Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: {Mysoft Api Adresi}/api/IYSConsent/ConsentBatchStatusUpdated
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
transctionGuid
|
String
|
Çoklu İleti Gönderimi İşleminin
Başarılı Olması Sonucunda Dönen GUID
|
Gelen Cevap
(Response) Parametreler (Çoklu Sonuç Dönen Model)
Güncellenen
kayıtların listesi döner.
|
Response
Parametreleri (Liste
Halinde Gelir)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
type
|
String (ENUM)
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu
belirlediği tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM")
|
|
status
|
String (Enum)
|
("ONAY", "RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS
tarafından tekil olarak atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
|
errorMessage
|
String
|
|
|
errorCode
|
String
|
Hata kodudur.
|
Örnek İstek
ve Cevap
İstek
(Request)
(Post)
//{Mysoft IYS Api Adresi}/api/IYSConsent/ConsentBatchStatusUpdated
{
"brandCode" : "6665554",
"transctionGuid": "638bfa83-c188-47a3-81e6-4aef718d27c5"
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": [
{
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": null,
"retailerAccess": null
"specialValue": "Özel Değer"
},
{
"recipient": "eposta@mail.com",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599},
"specialValue": "Özel Değer"
}
],
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
İşlem
Yapılmayan Kayıtlar
Toplu olarak yapılan
api çağrısı sonucunda daha önceden işlenen ve üzerinde işlem yapılmayan
kayıtların listelendiği metoddur.
Metod
Erişim Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: {Mysoft Api Adresi}/api/IYSConsent/ConsentBatchStatusIsUsedBefore
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
transctionGuid
|
String
|
Çoklu İleti Gönderimi İşleminin
Başarılı Olması Sonucunda Dönen GUID
|
Gelen Cevap
(Response) Parametreler (Çoklu Sonuç Dönen Model)
Daha önceden
işlenmiş ve değişiklik uygun olmayan kayıtların listesi dönülmektedir.
|
Response
Parametreleri (Liste
Halinde Gelir)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
type
|
String (ENUM)
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu
belirlediği tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM")
|
|
status
|
String (Enum)
|
("ONAY", "RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS
tarafından tekil olarak atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
|
errorMessage
|
String
|
Hata mesajını döner
|
|
errorCode
|
String
|
Hata kodunu döner
|
Örnek İstek
ve Cevap
İstek
(Request)
(Post)
//{Mysoft IYS Api Adresi}/api/IYSConsent/ConsentBatchStatusIsUsedBefore
{
"brandCode" : "6665554",
"transctionGuid": "638bfa83-c188-47a3-81e6-4aef718d27c5"
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": [
{
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": null,
"retailerAccess": null,
"specialValue": "Özel Değer"
},
{
"recipient": "eposta@mail.com",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599}
}
],
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Çoklu
IYS’ye Gönderim Sorgulama
Toplu olarak yapılan
api çağrısı sonucunda başarılı olarak MYSOFT sistemine kaydedilen kayıtların
IYS'ye gönderim ve sorgulama durumlarının listelendiği metoddur.
Metod
Erişim Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: {Mysoft Api Adresi}/api/IYSConsent/ConsentBatchSendIYSStatus
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
transctionGuid
|
String
|
Çoklu İleti Gönderimi İşleminin
Başarılı Olması Sonucunda Dönen GUID
|
|
isSendAllData
|
bool
|
TransactionGuid'e ait tüm kayıtların başarılı ve hatalı durumlarını döndüren parametredir. Bu true dönerse tüm kayıtlar son durumlarını döner false dönerse sadece IYSye iletilebilen kayıtlar son durumlarını döner.
|
Gelen Cevap
(Response) Parametreler (Çoklu Sonuç Dönen Model)
Kayıtlar ve
durumları dönülür. iysSendStatus: 15-IYS'ye gönderiliyor,11-IYS'ye
gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı başarısız
|
Response
Parametreleri (Liste
Halinde Gelir)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
type
|
String (ENUM)
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu
belirlediği tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM")
|
|
status
|
String (Enum)
|
("ONAY", "RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS
tarafından tekil olarak atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
|
errorMessage
|
String
|
IYS’den gelen hata mesajları
dönülür.
|
|
errorCode
|
String
|
IYS’den gelen hata kodunu
dönülür.
|
|
iysSendStatus
|
int
|
iysSendStatus: IYS sistemine
gönderim için kullanılan sistem değerleridir. Kaydın Mysoft Portalindeki
durumlarını ifade eder.
Değerler : 15-IYS'ye
gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı
başarısız
|
|
iysSendStatusText
|
string
|
iysSendStatus alanının text
karşılığıdır.
Değerler: 15-IYS'ye
gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı
başarısız
|
|
iysCreationDate
|
String (date-time)
|
IYS sistemine gönderilen kaydın IYS
de oluşma zamanı. Format (2018-02-10 09:30:00) Şeklindedir.
|
|
iysTransactionId
|
string
|
IYS sistemine gönderilen kaydın
tekil anahtarıdır.
|
Örnek İstek
ve Cevap
İstek
(Request)
(Post)
//{Mysoft IYS Api Adresi}/api/IYSConsent/ConsentBatchSendIYSStatus
{
"brandCode" : "6665554",
"transctionGuid": "638bfa83-c188-47a3-81e6-4aef718d27c5"
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": [
{
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": null,
"retailerAccess": null,
"specialValue": "Özel Değer",
"errorMessage": null,
"errorCode": null,
"iysSendStatus": 11,
"iysSendStatustext":
"IYS’ye
Gönderildi."
,
"iysCreationDate":"2020-01-01 09:30:00",
"iysTransactionId":"162cc11223344debc34dfe84ed",
},
],
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Alıcı Bilgileri
İle Durum Sorgulama
Alıcı
bilgisinin Mysoft sistemindeki durumlarını kontrol eden metoddur.
Metod
Erişim Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: {Mysoft Api Adresi}/api/IYSConsent/RecipientStatus
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
Marka parametresi doldurulması zorunlu değildir.
Doldurulmazsa Hizmet sağlayıcının tüm markalarındaki bilgileri kontrol
edilir.
|
|
recipient
|
String
|
Alıcı bilgisidir. Mail ya da Telefon
bilgisidir. Kayıt işleminde yapılan kontrollerbu alan içinde yapılmaktadır.
|
Gelen Cevap
(Response) Parametreler (Çoklu Sonuç Dönen Model)
Kayıtlar ve
durumları dönülür. iysSendStatus: 15-IYS'ye gönderiliyor,11-IYS'ye gönderildi,13-IYS'
den cevap bekleniyor,18-IYS kaydı başarısız
|
Response
Parametreleri (Liste
Halinde Gelir)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka bilgisidir.
|
|
recipient
|
String
|
Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.
|
|
recipientType
|
String (ENUM)
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
|
type
|
String (ENUM)
|
("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu
belirlediği tarihtir.
Örnek Format (2018-02-10 09:30:00)
|
|
source
|
String (Enum)
|
("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK",
"HS_2015", "HS_ATM")
|
|
status
|
String (Enum)
|
("ONAY", "RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS
tarafından tekil olarak atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
|
errorMessage
|
String
|
IYS’den gelen hata mesajları
dönülür.
|
|
errorCode
|
String
|
IYS’den gelen hata kodu
dönülür.
|
|
iysSendStatus
|
int
|
iysSendStatus: IYS sistemine
gönderim için kullanılan sistem değerleridir. Kaydın Mysoft Portalindeki
durumlarını ifade eder.
Değerler : 15-IYS'ye
gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı
başarısız
|
|
iysSendStatusText
|
string
|
iysSendStatus alanının text
karşılığıdır.
Değerler: 15-IYS'ye
gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı
başarısız
|
|
iysCreationDate
|
String (date-time)
|
IYS sistemine gönderilen kaydın IYS
de oluşma zamanı. Format (2018-02-10 09:30:00) Şeklindedir.
|
|
iysTransactionId
|
string
|
IYS sistemine gönderilen kaydın
tekil anahtarıdır.
|
Örnek İstek
ve Cevap
İstek
(Request)
(Post)
//{Mysoft IYS Api Adresi}/api/IYSConsent/RecipientStatus
{
"brandCode" : "606202",
"recipient": "mail@example.com"
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": [
{
"brandCode": "606202",
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": null,
"retailerAccess": null,
"specialValue": "Özel Değer",
"errorMessage": null,
"errorCode": null,
"iysSendStatus": 11,
"iysSendStatustext":
"IYS’ye
Gönderildi."
,
"iysCreationDate":"2020-01-01 09:30:00",
"iysTransactionId":"162cc11223344debc34dfe84ed",
},
],
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Geçmişe Dönük Kayıtları Sorgulama
Çağrıya geçilen parametrelere göre filtrelenip Geçmişe dönük kayıtların sorgulandığı metoddur.
Metod Erişim
Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSConsent/ConsentQuery
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
afterValue
|
Integer
|
Çağrı başına 10.000 kayıt sınırı olduğu için tüm datayı 10'ar binlik parçalar halinde çekmek için kayıtın başlangıç kayıt numarasını belirtir. İlk 10 binliğin istendiği çağrıda belirtilmesi gerekmez. İlk istekte 10 binlik datayı getirir ve afterValue değeri döner. Bu dönen değere göre sonraki isteklerde kayıtların çağrılmaya başlanacağı kayıt numarasını tanımlar.
|
|
sendDate
|
String (date-time)
|
Gönderim Tarihi. Örnek Format (2018-02-10 09:30:00). Sorguda başlangıç tarihi
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin tarihi aralığı başlangıcı. Örnek Format (2018-02-10 09:30:00). Sorguda başlangıç tarihi
|
|
iysCreationDate
|
String (date-time)
|
IYS sistemine gönderilen kaydın IYS de oluşma zamanı. Format (2018-02-10 09:30:00) Şeklindedir.
|
|
type
|
String (ENUM) Liste
|
("ARAMA", "MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim kanalıdır.
|
|
recipientType
|
String (ENUM) Liste
|
("BIREYSEL", "TACIR"). Tacir durumunu gösteren bilgidir.
|
|
source
|
String (ENUM) Liste
|
("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM","IYS_3338","IYS_CM", "IYS_WEB", "IYS_MOBIL",
"IYS_KISA_LINK")
|
|
status
|
String (ENUM) Liste
|
("ONAY", "RET") Vatandaşın izin durumunu gösterir.
|
|
limit
|
Integer
|
İstek başına sonuç limitini belirler. Maksimum 10000 olabilir.
|
|
sendDateEnd
|
String (date-time)
|
Mysoft IYS gönderim tarihi bitişi, Örnek Format (2018-02-10 09:30:00)
|
|
consentDateEnd
|
String (date-time)
|
Vatandaşın iletişim izin tarihi aralığı bitişi, Örnek Format (2018-02-10 09:30:00)
|
|
iysCreationDateEnd
|
String (date-time)
|
IYS kayıt tarihi aralığı bitişi, Örnek Format (2018-02-10 09:30:00)
|
|
mainSource
|
String (ENUM) Liste
|
("HS","IYS") HS seçilirse tüm HS kaynakları seçilmiş olur. IYS seçilirse tüm IYS kaynakları seçilmiş olur
|
|
specialValue
|
String Liste
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır. Liste halinde girilir
|
Gelen Cevap (Response) Parametreler
(Tekli
Sonuç Dönen Model)
|
Response
Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
afterValue
|
String
|
Çağrı başına 10.000 kayıt sınırı olduğu için tüm datayı 10'ar binlik parçalar halinde çekmek için kayıtın başlangıç kayıt numarasını belirtir.
|
|
recordCount
|
Integer
|
Kayıt sayısını belirtir
|
|
consentData
|
ConsentDataResponseModel Listesi
|
Generic Listenin İçinde ConsentDataResponseModel
|
ConsentDataResponseModel
|
ConsentDataResponseModel
|
|
Parametre Adı
|
Parametre Tipi
|
Açıklama
|
|
consentDate
|
String
(date-time)
|
Vatandaşın
iletişim izin durumunu belirlediği tarihtir. Alıcı tipi TACIR ise eklenmesi
zorunlu değildir. Örnek Format (2018-02-10 09:30:00)
|
|
recipient
|
String
|
Vatandaşın
sistemde kayıtlı telefon numarası veya e-posta bilgisidir. Eposta adresleri
284, telefon numaraları 15 karakterden daha uzun olamaz. Telefon numarası
+905813334455 formatına uygun olmalıdır. ([+][country code][area code][local
phone number]) (+905555555555)
|
|
recipientType
|
String
(ENUM)
|
Sadece
2 değer alır. ("BIREYSEL", "TACIR"). Tacir durumunu
gösteren bilgidir. (Varsayılan değer: BIREYSEL)
|
|
status
|
String
(Enum)
|
Sadece
2 değer alır ("ONAY", "RET") Vatandaşın izin durumunu
gösterir.
|
|
type
|
String
(ENUM)
|
Sadece
3 değer alır. ("ARAMA", "MESAJ", "EPOSTA")
Vatandaşın izin verdiği iletişim kanalıdır.
|
|
source
|
String
(ENUM)
|
Sadece
12 değer alır. ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA",
"HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK",
"HS_2015", "HS_ATM")
|
|
retailerCode
|
Integer
(Nullable) (int?)
|
İzin
alınmasına aracılık eden bayiye İYS tarafından tekil olarak atanan İYS numarası
bilgisidir.
|
|
retailerAccess
|
Integer
Generic List (List<int>)
|
İzne
erişimi olan bayilere İYS tarafından tekil olarak atanan İYS numaraları
listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
|
explanation
|
String
|
Açıklama
|
|
errorMessage
|
String
|
Hata
mesajı
|
|
errorCode
|
String
|
Hata
Kodu
|
|
iysSendStatus
|
Integer
|
Gönderim
durumu
|
|
iysSendStatusText
|
String
|
Gönderim
durumu Metni
|
|
iysCreationDate
|
String
(date-time)
|
IYS
sistemine gönderilen kaydın IYS de oluşma zamanı. Format (2018-02-10
09:30:00) Şeklindedir.
|
|
iysTransactionId
|
string
|
IYS
sistemine gönderilen kaydın tekil anahtarıdır.
|
Örnek
İstek ve Cevap
İstek
(Request)
(POST)
{
"brandCode": "555556655",
"afterValue": null, //Bu alan ilk 10'binlik çekilirken boş bırakılır sonra doldurulur
"sendDate": "2018-02-10 09:30:00",
"consentDate": "2018-02-10 09:30:00",
"iysCreationDate": "2018-02-10 09:30:00",
"type": ["ARAMA", "MESAJ", "EPOSTA"],
"recipientType": ["BIREYSEL", "TACIR"],
"source": ["HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM"],
"status": ["ONAY", "RET"],
"limit": 10000,
"sendDateEnd": "2018-02-10 09:30:00",
"consentDateEnd": "2018-02-10 09:30:00",
"iysCreationDateEnd": "2018-02-10 09:30:00",
"mainSource": ["HS", "IYS"],
"specialValue": ["Özel Değer 1", "Özel Değer 2"]
}
Cevap
(Response) Başarılı
{
"succeed": true,
"data": {
"brandCode": "555556655",
"afterValue": 10000, //10 binden fazla kayıt varsa bir sonraki istekte başlanılacak kayıt numarasını verir
"recordCount": 100,
"consentData": [
{
"recipient": "+905555555555",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599}
},
{
"recipient": "eposta@mail.com",
"recipientType": "BIREYSEL",
"type": "MESAJ",
"consentDate": "2018-02-10 09:30:00",
"source": "HS_FIZIKSEL_ORTAM",
"status": "ONAY",
"retailerCode": 1553855,
"retailerAccess": {5556665665, 6569885955, 5665656556, 8998855599}
}
]
},
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Bayi Listeleme
brandCode ile
eşleşen bayi listesini görmek için kullanılmalıdır.
Metod Erişim
Bilgileri
//Erişim Metodu (Get)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSRetailer/IYSRetailers
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
offset
|
Integer
|
Veri
gösterilmeye başlanacak sıra numarasıdır.
|
Gelen
Cevap (Response) Parametreler
(Çoklu Sonuç Dönen List Model)
|
Response
Parametreleri (Liste
Halinde Gelir)
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
pagination
|
RetailerPaginationModel
|
Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.
|
|
retailerData
|
List<RetailerDataResponseModel>
|
("BIREYSEL",
"TACIR"). Tacir durumunu gösteren bilgidir.
|
RetailerPaginationModel
|
RetailerPaginationModel
|
|
Parametre Adı
|
Parametre Tipi
|
Parametre Açıklama
|
|
offset
|
Integer
|
Veri gösterilmeye başlanacak sıra
numarasıdır.
|
|
pageSize
|
Integer
|
Pagination istekte verilmez ise
default 100 değerini alır.
|
|
totalCount
|
Integer
|
Tüm sayfalardaki toplam kayıt
sayısı bilgisidir.
|
RetailerDataResponseModel
|
RetailerDataResponseModel
|
|
Parametre Adı
|
Parametre Tipi
|
Parametre Açıklama
|
|
title
|
String
|
Bayiye ait ticari unvan
bilgisidir.
|
|
mersis
|
String
|
Hizmet sağlayıcının MERSİS numarası
bilgisidir.
|
|
alias
|
String
|
Bayi tanımı bilgisidir.
|
|
name
|
String
|
Bayi yetkilisi Adı-Soyad
bilgisidir.
|
|
tckn
|
String
|
Bayi yetkilisi TCKN (11 hane TC
Kimlik No) bilgisidir.
|
|
mobile
|
String
|
Bayi yetkilisine ait telefon
numarası bilgisidir.
|
|
city
|
CityModel
|
İl veya ilçe bilgisi modeli.
|
|
town
|
TownModel
|
İl veya ilçe bilgisi modeli.
|
|
retailerAccessCount
|
Integer
|
Bayinin erişebildiği izin sayıdır.
|
|
canBeDeleted
|
Boolean
|
Bayinin sistemden silinip
silinemeyeceğinin bilgisidir.
|
|
status
|
String (Enum)
|
Sadece ("active",
"passive", "suspended") değerlerini alır. Bayi durum
bilgisidir.
|
CityModel
|
CityModel
|
|
Parametre Adı
|
Parametre Tipi
|
Parametre Açıklama
|
|
code
|
String
|
İl veya ilçe adı bilgisidir.
|
|
name
|
String
|
İl veya ilçe kodu
bilgisidir.
|
TownModel
|
TownModel
|
|
Parametre Adı
|
Parametre Tipi
|
Parametre Açıklama
|
|
code
|
String
|
İl veya ilçe adı bilgisidir.
|
|
name
|
String
|
İl veya ilçe kodu
bilgisidir.
|
Örnek
İstek ve Cevap
İstek
(Request)
(GET)
//{Mysoft IYS Api Adresi}/api/IYSRetailer/IYSRetailers
{"brandCode": "5589895", "offset": 1}
Cevap
(Response) Başarılı
Veri çok olduğunda sayfa sayfa ayırarak gruplandırır
{
"succeed": true,
"data": {
{
"pagination": {"offset": 0, "pageSize": 1, "totalCount": 2},
"retailerData": [
{
"title": "Firma Ltd",
"mersis": "55556595956",
"alias": "Avrupa Mağazası",
"name": "Firma Üretim A.Ş",
"tckn": "566898959595",
"mobile": "905555555555",
"city": {name: "ISTANBUL", code: "1"},
"town": {name: "SARIYER", code: "2"},
"status": "active",
"retailerAccessCount": 1,
"canBeDeleted": true
}
]
},
{
"pagination": {"offset": 1, "pageSize": 1, "totalCount": 2},
"retailerData": [
{
"title": "Firma Ltd",
"mersis": "55556595956",
"alias": "Avrupa Mağazası",
"name": "Firma Üretim A.Ş",
"tckn": "566898959595",
"mobile": "905555555555",
"city: {name": "ISTANBUL", code: "1"},
"town: {name": "SARIYER", code: "2"},
"status": "active",
"retailerAccessCount": 1,
"canBeDeleted": true
}
]
}
},
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Bayi
Sorgulama
Bayi
Sorgulama işlemi için kullanılır.
Metod Erişim
Bilgileri
//Erişim Metodu (Get)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSRetailer/IYSRetailer
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Hizmet sağlayıcının markasına özel,
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerCode
|
String
|
İzin alınmasına aracılık eden
bayiye İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
Gelen
Cevap (Response) Parametreler
(Tekli Sonuç Dönen Model)
|
Response
Parametreleri
|
|
Model Adı
|
Model Tipi
|
Model Açıklama
|
|
title
|
String
|
Bayiye ait ticari unvan
bilgisidir.
|
|
mersis
|
String
|
Hizmet sağlayıcının MERSİS numarası
bilgisidir.
|
|
alias
|
String
|
Bayi tanımı bilgisidir.
|
|
name
|
String
|
Bayi yetkilisi Adı-Soyad
bilgisidir.
|
|
tckn
|
String
|
Bayi yetkilisi TCKN (11 hane TC
Kimlik No) bilgisidir.
|
|
mobile
|
String
|
Bayi yetkilisine ait telefon numarası
bilgisidir.
|
|
city
|
CityModel
|
İl veya ilçe bilgisi modeli.
|
|
town
|
TownModel
|
İl veya ilçe bilgisi modeli.
|
|
retailerAccessCount
|
Integer
|
Bayinin erişebildiği izin sayıdır.
|
|
canBeDeleted
|
Boolean
|
Bayinin sistemden silinip silinemeyeceğinin
bilgisidir.
|
|
status
|
String (Enum)
|
Sadece ("active",
"passive", "suspended") değerlerini alır. Bayi durum
bilgisidir.
|
Örnek
İstek ve Cevap
İstek
(Request)
(GET)
//{Mysoft IYS Api Adresi}/api/IYSRetailer/IYSRetailer
{
"brandCode": "555555",
"retailerCode": "55555"
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": {
"title": "Firma",
"mersis": "6656565",
"alias": "Avrupa Şubesi",
"name": "Hasan Bey",
"tckn": "11111111111",
"mobile": "905555555555",
"city": {
"name": "SARIYER",
"code": "2"
},
"town: {
"name": "AYAZAĞA",
"code": "23"
},
"retailerAccessCount": 558866556,
"canBeDeleted": true,
"status": "active"
},
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Bayi
Ekleme
//{Mysoft IYS Api Adresi}/api/IYSRetailer/RetailerInsert
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Hizmet sağlayıcının markasına özel,
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
|
retailerData
|
RetailerDataModel
|
Bayi bilgisinin olduğu modeldir.
|
RetailerDataModel
|
RetailerDataModel
|
|
Parametre Adı
|
Parametre Tipi
|
Parametre Açıklama
|
|
title
|
String
|
Bayiye ait ticari unvan
bilgisidir.
|
|
mersis
|
String
|
Hizmet sağlayıcının MERSİS numarası
bilgisidir.
|
|
alias
|
String
|
Bayi tanımı bilgisidir.
|
|
name
|
String
|
Bayi yetkilisi Adı-Soyad
bilgisidir.
|
|
tckn
|
String
|
Bayi yetkilisi TCKN (11 hane TC
Kimlik No) bilgisidir.
|
|
mobile
|
String
|
Bayi yetkilisine ait telefon numarası
bilgisidir.
|
|
city
|
CityModel
|
İl veya ilçe bilgisi modeli.
|
|
town
|
TownModel
|
İl veya ilçe bilgisi modeli.
|
|
status
|
String (Enum)
|
Sadece ("active",
"passive", "suspended") değerlerini alır. Bayi durum
bilgisidir.
|
Gelen
Cevap (Response)
Parametreler (Tekli Sonuç Dönen Model)
Gelen cevapta
‘data’ parametresinin içinde Integer formatında numara döner.
Örnek
İstek ve Cevap
İstek
(Request)
(POST)
//{Mysoft IYS Api Adresi}/api/IYSRetailer/RetailerInsert
İstek
Sonucunda Integer formatında numara döner. İzin alınmasına aracılık eden bayiye
İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
{
"brandCode": "488456564",
"retailerData": {
"title": "Firma",
"mersis": "6656565",
"alias": "Avrupa Şubesi",
"name": "Hasan Bey",
"tckn": "11111111111",
"mobile": "905555555555",
"city": {
"name": "SARIYER",
"code": "2"
},
"town": {
"name": "AYAZAĞA",
"code": "23"
},
"status": "active"
}
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": 134343434,
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
Bayi
Silme
Bayi silme
işlemi için kullanılır. Bayi Ekleme işleminin sonucunda dönen numara ile işlem
yapılır.
Metod Erişim
Bilgileri
//Erişim Metodu (Delete)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/IYSRetailer/RetailerRemove
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Hizmet sağlayıcının markasına özel, İYS tarafından tekil
olarak atanan İYS numarası bilgisidir.
|
|
retailerCode
|
String
|
İzin alınmasına aracılık eden
bayiye İYS tarafından tekil olarak atanan İYS numarası bilgisidir.
|
Gelen
Cevap (Response) Parametreler
(Tekli Sonuç Dönen Model)
Gelen cevapta
‘data’ parametresinin içinde String formatında işlemin sonucunu belirten
açıklama döner.
Örnek
İstek ve Cevap
İstek
(Request)
(POST)
//{Mysoft IYS Api Adresi}/api/IYSRetailer/RetailerRemove
{
"brandCode": "111555",
"retailerCode": "5555566"
}
Cevap
(Response)
Başarılı
{
"succeed": true,
"data": "Başarı",
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
WebHook Servisleri
WebHook servisleri Mysoft tarafından entegre olan sistemlerin tetiklendiği API metodlarıdır. Webhook IYS sisteminde tespit edilen değişikliklerin anlık olarak ilgili firma servislerine aktarılmasını sağlamaktadır. Webhook API Bilgileri Mysoft Portal üzerinde kaydı yapılmalıdır. Bu işlem Portal üzerinde Firma bilgileri ekranında IYS tabında gerçekleştirlebilir. Burada yapılacak işlem Post işlemidir. Bu işlemde post edilecek data json olarak post edilecektir. Hata durumlarında exception oluşturması beklenmektedir. Geri dönüş değeri kontrol edilmeyecektir. Çağrının 200 ile sonuçlanması durumunda işlem başarılı olarak sayılacaktır. Bu işlem için Post edilecek obje WebhookConsentModeldir. Model properties aşağıda belirtilmiştir.
WebhookConsentModel Post Nesnesi
|
Post Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
webHookKey
|
String
|
Çağrılar için istenen özel alanı ifade eder. Webhook bilgisi portale kaydedilirken girilen özel anahtar değeridir. Çağrıları engellemek amacı ile eklenmiştir.
|
|
brandCode
|
String
|
Marka Kodu
|
|
consentData
|
ConsentDataModel
|
Eklenen Veri Modeli (Tekil)
|
ConsentDataModel
|
ConsentDataModel
|
|
Parametre Adı
|
Parametre Tipi
|
Açıklama
|
|
recipient
|
String
|
Vatandaşın
sistemde kayıtlı telefon numarası veya e-posta bilgisidir. Eposta adresleri
284, telefon numaraları 15 karakterden daha uzun olamaz.
Telefon numarası +905813334455 formatına uygun olmalıdır.
([+][country code][area code][local phone number]) (+905555555555)
|
|
recipientType
|
String (ENUM)
|
Sadece 2 değer alır.
("BIREYSEL", "TACIR"). Tacir durumunu gösteren bilgidir.
(Varsayılan değer: BIREYSEL)
|
|
type
|
String (ENUM)
|
Sadece 3 değer alır. ("ARAMA",
"MESAJ", "EPOSTA") Vatandaşın izin verdiği iletişim
kanalıdır.
|
|
consentDate
|
String (date-time)
|
Vatandaşın iletişim izin durumunu belirlediği tarihtir.
Alıcı tipi TACIR ise eklenmesi zorunlu değildir. Örnek Format (2018-02-10
09:30:00)
|
|
source
|
String (Enum)
|
Sadece 12 değer alır. ("HS_FIZIKSEL_ORTAM",
"HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI",
"HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ",
"HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM","HS_EORTAM", "HS_ETKINLIK", "HS_2015",
"HS_ATM","IYS_3338","IYS_CM", "IYS_WEB", "IYS_MOBIL",
"IYS_KISA_LINK")
|
|
status
|
String (Enum)
|
Sadece 2 değer alır ("ONAY",
"RET")
Vatandaşın izin durumunu gösterir.
|
|
retailerCode
|
Integer (Nullable) (int?)
|
İzin alınmasına aracılık eden bayiye İYS tarafından tekil
olarak atanan İYS numarası bilgisidir.
|
|
retailerAccess
|
Integer Generic List (List<int>)
|
İzne erişimi olan bayilere İYS tarafından tekil olarak
atanan İYS numaraları listesini gösterir.
|
|
specialValue
|
String
|
Özel değer girilmesi için kullanılan alandır. 50 karakter ile sınırlıdır, 50 karakterden fazla girilir ise ilk 50 karakter alınır.
|
Hatalı Webhook Çağrıları
Webhook çağrılarının hatalı olarak sonuçlananların listelendiği çağrı listesidir.
Metod Erişim
Bilgileri
//Erişim Metodu (Post)
//Test Ortamı: https://iysapitest.mysoft.com.tr/api/webhook/errorList
İstek
(Request) Atarken Parametreler
|
Request Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
afterValue
|
Integer
|
Çağrı başına 10.000 kayıt sınırı olduğu için tüm datayı 10'ar binlik parçalar halinde çekmek için kayıtın başlangıç kayıt numarasını belirtir. İlk 10 binliğin istendiği çağrıda belirtilmesi gerekmez. İlk istekte 10 binlik datayı getirir ve afterValue değeri döner. Bu dönen değere göre sonraki isteklerde kayıtların çağrılmaya başlanacağı kayıt numarasını tanımlar.
|
|
createDate
|
String (date-time)
|
Webhookun oluşturulduğu tarih. Örnek Format (2020-01-10). Sorguda başlangıç tarihi başlangıcı. Bitiş tarihi dolu ise aralık between şeklinde bakılır. createDateEnd boş geçilirse createDate eşit olan günler olarak tek gün şeklinde bakılır.
|
|
createDateEnd
|
String (date-time)
|
Webhookun oluşturulduğu tarih. Örnek Format (2020-01-10). Sorguda başlangıç tarihi bitişi
|
|
limit
|
Integer
|
İstek başına sonuç limitini belirler. Maksimum 10000 olabilir.
|
Gelen Cevap (Response) Parametreler
(Tekli
Sonuç Dönen Model)
|
Response
Parametreleri
|
|
Model Adı
|
Model Tipi
|
Açıklama
|
|
brandCode
|
String
|
Marka Kodu
|
|
afterValue
|
String
|
Çağrı başına 10.000 kayıt sınırı olduğu için tüm datayı 10'ar binlik parçalar halinde çekmek için kayıtın başlangıç kayıt numarasını belirtir.
|
|
recordCount
|
Integer
|
Kayıt sayısını belirtir
|
|
consentData
|
WebhookErrorResponseModel Listesi
|
Generic Listenin İçinde WebhookErrorResponseModel
|
WebhookErrorResponseModel
|
WebhookErrorResponseModel
|
|
Parametre Adı
|
Parametre Tipi
|
Açıklama
|
|
webhookGuid
|
String
|
webhook çağrısı için verilen anahtar değeri.
|
|
consentData
|
consentDataResponseModel
|
İzin bilgisi modeli
|
Örnek
İstek ve Cevap
İstek
(Request)
(POST)
{
"brandCode": "555556655",
"afterValue": null,
//Bu alan ilk 10'binlik çekilirken boş bırakılır sonra doldurulur
"createDate": "2018-02-10 09:30:00",
"createDateEnd": "2018-02-10 09:30:00",
"limit": 10000,
}
Cevap
(Response) Başarılı
{
"succeed": true,
"data": {
"brandCode":
"555556655",
"afterValue":
10000,
//10 binden fazla kayıt varsa bir sonraki istekte başlanılacak kayıt numarasını verir
"recordCount":
100,
"webhookList":
[
{
"webhookGuid":
"abcd-abcd-abcd-abcd",
"consentData" : {
"recipient":
"eposta@mail.com",
"recipientType":
"BIREYSEL",
"type":
"MESAJ",
"consentDate":
"2018-02-10 09:30:00",
"source":
"HS_FIZIKSEL_ORTAM",
"status":
"ONAY",
"retailerCode":
1553855,
"retailerAccess":
{5556665665,
6569885955
, 5665656556,
8998855599
}
}
}
]
},
"message": null
}
Başarısız
{
"succeed": false,
"data": null,
"message": "Hata Mesajı"
}
