Member Service
Geliştiricinin her hangi bir web servis ile etkileşime geçebilmesi için, öncelikle Login metodunu kullanarak bir Service Ticket alması gerekir. Diğer web servis ve metodlarına yaratmış olduğu bu değer ile istekte bulunabilir.
Dakikada gönderilebilecek en fazla istek sayısı 1000'dir.
Metod | Açıklama |
|---|---|
Belli bir kullanıcıyı tüm listelere ekler. | |
Belli bir kullanıcıyı belirtilen listelere ekler. | |
E-mail ile kullanıcının izin bilgisini günceller. | |
Push uygulaması için yeni bir token ekler. | |
Belirli bir üyenin ID'si üzerinden email adresini döndürür. | |
Yeni üyeyi, demografik bilgileri ile ekler. | |
Üyenin belirtilen tarih aralığında aldığı kampanya bilgilerini gösterir. | |
Üyeye ait demografik alanları listeler. | |
Belli bir üyeye ait 32 karakterlik ID’yi döndürür. | |
Belli bir üyenin bulunduğu listeleri gösterir. | |
Belli bir üyeyi belli bir listeden çıkartır. | |
Üye’nin demografik bilgilerini günceller, sistemde yer almıyorsa ekler ve sonunda bir email kampanyası tetikler. | |
Üye’nin demografik bilgilerini günceller, sistemde yer almıyorsa ekler ve sonunda bir SMS kampanyası tetikler. | |
Üyenin demografik bilgilerini günceller. | |
Belirlenen tarih aralığında güncellenen izinlerin hangi üyelere ait olduğunu sorgular. | |
Verilen referans ID ile üyeyi siler. Müşterinin ayarlarına göre referans id Mail veya KeyId olabilir. | |
Silinen üyenin hangi bilgilerinin silindiği bilgisini özet olarak verir. |
InsertMemberDemography
URL | LIVE: https://api.relateddigital.com/resta/api/Member/InsertMemberDemography ECOMM: https://api.relateddigital.com/reste/api/Member/InsertMemberDemography LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/InsertMemberDemography LIVEM: https://api.relateddigital.com/restm/api/Member/InsertMemberDemography |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body | Key (string): Bu alanda hesap özelinde tanımlanan birincil anahtar sütunu (EMAIL, KEY_ID) yer almalıdır. Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez. ForceUpdate (bool): Key ve Value değerleri mevcut bir üyeyi saptarsa, metod ekleme yapmak yerine varolanı güncellemeye / güncellememeye karar verir. Bu flag True değerini aldığında, sağlanan demografik bilgileri kullanarak üyeyi günceller.. DemographicData (KeyValue []): Bu bir KeyValue dizisidir. Kısacası, demografik bilgileri oluşturan Key ve Value değerleri. Bilgilendirme Doğum tarihi formatı aşağıdaki gibi olmalıdır;
GSM formatı aşağıdaki gibi olmalıdır;
Eğer hesap yurt dışı gönderime açıksa bu durumda yükleme (ülke kodu).(mobil no) formatı olarak yapılmalıdır. |
Sample Body | { "Key" : "", "Value" : "", "ForceUpdate" : false, "DemographicData" : [ { "Key" : "", "Value": ""}, { "Key" : "", "Value": ""} ] } |
Sample Response | { "MemberId": "" "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01, 06, 25, 43, 69, 99, 107 |
UpdateMemberDemography
URL | LIVE: https://api.relateddigital.com/resta/api/Member/UpdateMemberDemography ECOMM: https://api.relateddigital.com/reste/api/Member/UpdateMemberDemography LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/UpdateMemberDemography LIVEM: https://api.relateddigital.com/restm/api/Member/UpdateMemberDemography |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body | Key (string): Bu alanda hesap özelinde tanımlanan birincil anahtar sütunu (EMAIL, KEY_ID) yer almalıdır. Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez. ForceInsert (bool): Key ve Value değerleri mevcut bir üyeyi saptarsa, metod ekleme yapmak yerine varolanı güncellemeye / güncellememeye karar verir. Bu flag True değerini aldığında, sağlanan demografik bilgileri kullanarak üyeyi günceller.. DemographicData (KeyValue []): Bu bir KeyValue dizisidir. Kısacası, demografik bilgileri oluşturan Key ve Value değerleri. |
Sample Body | { "Key" : "", "Value" : "", "ForceInsert" : true, "DemographicData" : [ { "Key" : "", "Value": ""}, { "Key" : "", "Value": ""} ] } |
Sample Response | { "MemberId": "" "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01, 06, 43, 66, 69, 99, 107 |
AddToSendLists
URL | LIVE: https://api.relateddigital.com/resta/api/Member/AddToSendLists ECOMM: https://api.relateddigital.com/reste/api/Member/AddToSendLists LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/AddToSendLists LIVEM: https://api.relateddigital.com/restm/api/Member/AddToSendLists |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body | Key (string): Bu alanda hesap özelinde tanımlanan birincil anahtar sütunu (EMAIL, KEY_ID) yer almalıdır. Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez. Move (bool): If Move is given True, the member will be removed from the old lists which are not specified in SendLists array. If Move is given False, the member will only be added to the specified lists. SendLists (SendList []): The member specified by Key and Value pair will be added to these lists. |
Sample Body | { "Key" : "", "Value" : "", "Move" : false, "SendLists" : [ { "ListName" : "", "GroupName": ""}, { "ListName" : "", "GroupName": ""} ] } |
Sample Response | { "MemberId": "" "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized Status Code: 404 Not Found |
Error Code | 00, 01, 43, 66, 69, 99, 107 |
QueryMemberID
URL | LIVE: https://api.relateddigital.com/resta/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com ECOMM: https://api.relateddigital.com/reste/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com LIVEM: https://api.relateddigital.com/restm/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com |
|---|---|
Http verb | GET |
Parameters | Key (string): Bu alanda hesap özelinde tanımlanan birincil anahtar sütunu (EMAIL, KEY_ID) yer almalıdır. Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez. |
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body |
|
Sample Body |
|
Sample Response | { "MemberId": "" "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized Status Code: 404 Not Found |
Error Code | 00, 01,43,69, 99, 107 |
QueryMemberDemography
URL | LIVE: https://api.relateddigital.com/resta/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com ECOMM: https://api.relateddigital.com/reste/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com LIVEM: https://api.relateddigital.com/restm/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com |
|---|---|
Http verb | GET |
Parameters | Key (string): Bu alanda hesap özelinde tanımlanan birincil anahtar sütunu (EMAIL, KEY_ID) yer almalıdır. Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez. |
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body |
|
Sample Body |
|
Sample Response | { "DemographicData" : [ { "Key" : "", "Value": ""}, { "Key" : "", "Value": ""} ] "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized Status Code: 404 Not Found |
Error Code | 00, 01,43,69, 99, 107 |
QuerySendLists
URL | LIVE: https://api.relateddigital.com/resta/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com ECOMM: https://api.relateddigital.com/reste/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com LIVEM: https://api.relateddigital.com/restm/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com |
|---|---|
Http verb | GET |
Parameters | Key (string): Bu alanda hesap özelinde tanımlanan birincil anahtar sütunu (EMAIL, KEY_ID) yer almalıdır. Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez. |
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body |
|
Sample Body |
|
Sample Response | { "SendLists" : [ { "ListName" : "", "GroupName": ""}, { "ListName" : "", "GroupName": ""} ] "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized Status Code: 404 Not Found |
Error Code |