Post Service
Transactional (Tekil) Email Web Service Metodları
Transactional (Tekil) Email web servisini kullanarak, şifre hatırlatma, üyelik aktivasyonu, siparişiniz kargoda, gibi bilgilendirme amaçlı e-posta gönderebilir ve analiz için bunların sonuçlarını çekebilirsiniz.
Aşağıdaki tabloda Transactional Email Web Servisine ait metodlar ve kısa açıklamaları listelenmektedir. Detaylı bilgi için metod isimlerine tıklayabilirsiniz.
Dakikada gönderilebilecek en fazla istek sayısı 1000'dir.
Metod | Açıklama |
|---|---|
| |
İki tarih aralığında geçersiz yada ulaşmayan adres olarak raporlanan transactional e-postaları sorgular. | |
İki tarih aralığında gönderilen transactional e-postaların durumunu sorgular. | |
İki tarih aralığında ulaşım durumu değişmiş (okunmuş, geçersiz raporlanmış vb.) transactional e-postaları sorgular. | |
Girilen PostID’lere ilişkin e-postaların durumunu sorgular. | |
Kampanya Tipi veya Gönderen Adreslerden biri belirtilerektransactional e-postaların durumunu sorgular. | |
Gönderilen bir transactional e-postanın durumunu sorgular. | |
Bir adrese transactional bir e-posta gönderilmesini sağlar. | |
Bir adrese, CC ve BCC ekleyerek transactional bir e-posta gönderilmesini sağlar. | |
Hesabınızda tanımlı bir HTML şablonu bir e-posta adresine gönderebilmenizi sağlar. | |
Hesabınızda tanımlı bir XSLT şablonu bir e-posta adresine gönderebilmenizi sağlar. | |
|
Geliştiricinin herhangi 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.
CreateTransactionalEmailTemplate
URL | LIVE: https://api.relateddigital.com/resta/api/Template/CreateTransactionalEmailTemplate ECOMM: https://api.relateddigital.com/reste/api/Template/CreateTransactionalEmailTemplate LIVEB: https://api.relateddigital.com/liveb_rest/api/Template/CreateTransactionalEmailTemplate LIVEM: https://api.relateddigital.com/restm/api/Template/CreateTransactionalEmailTemplate |
|---|---|
Http verb |
|
Parameters |
|
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login. |
Body |
|
Sample Body |
|
Sample Response |
|
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
|
PostHtml
URL | LIVE: https://api.relateddigital.com/resta/api/post/PostHtml ECOMM: https://api.relateddigital.com/reste/api/post/PostHtml LIVEB: https://api.relateddigital.com/liveb_rest/api/post/PostHtml LIVEM: https://api.relateddigital.com/restm/api/post/PostHtml |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login. |
Body | FromName (string): From Name of the e-mail., FromAddress (string): From address of the e-mail., ReplyAddress (string): Reply address of the e-mail., Subject (string): Subject of the e-mail., HtmlBody (string): Content of the e-mail as html., Charset (string): Char set of the e-mail., ToName (string): Name of the receiver., ToEmailAddress (string): Email address of the receiver., PostType(string): Optional parameter.Type of email (account activation, survey, etc.)., KeyId(string): Optional parameter. Unique member id in your system., CustomParams(string): Optional parameter. Custom parameters., Attachments (List<Attachment>): Attachment: Name(string): Name of attachment., Type(string): Type like pdf,doc., Content(base64Binary): Contents of file. |
Sample Body | { "FromAddress": "", "ReplyAddress": "", "Subject": "", "HtmlBody": "<html><head></head><body>Hello World!!</body></html>", "Charset": "iso-8859-9", "ToName": "", "ToEmailAddress": "", "Attachments": [ { "Name": "", "Type": "PDF or DOC", "Content": "" } "PostType": "", "KeyId": "", "CustomParams": ""
|
Sample Response | { "PostId":”F50656781FFA45338C1F28499555A0BC” "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550 |
PostHtmlWithTypeCCandBCC
URL | LIVE: https://api.relateddigital.com/resta/api/post/PostHtml ECOMM: https://api.relateddigital.com/reste/api/post/PostHtml LIVEB: https://api.relateddigital.com/liveb_rest/api/post/PostHtml LIVEM: https://api.relateddigital.com/restm/api/post/PostHtml |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login. |
Body | FromName (string): From Name of the e-mail., FromAddress (string): From address of the e-mail., ReplyAddress (string): Reply address of the e-mail., Subject (string): Subject of the e-mail,. HtmlBody (string): Content of the e-mail as html., Charset (string): Char set of the e-mail., ToName (string): Name of the receiver., ToEmailAddress (string): Email address of the receiver., PostType(string): Optional parameter.Type of email (account activation, survey, etc.)., KeyId(string): Optional parameter. Unique member id in your system., CustomParams(string): Optional parameter. Custom parameters., CcAddress(string): Optional parameter., BccAddress(string): Optional parameter., Attachments (List<Attachment>): Attachment: Name(string): Name of attachment., Type(string): Type like pdf,doc., Content(base64Binary): Contents of file., |
Sample Body | { "FromAddress": "", "ReplyAddress": "", "Subject": "", "HtmlBody": "<html><head></head><body>Hello World!!</body></html>", "Charset": "iso-8859-9", "ToName": "", "ToEmailAddress": "", "CcAddress":"", "BccAddress":"", "Attachments": [ { "Name": "", "Type": "PDF or DOC", "Content": "" "PostType": "", "KeyId": "", "CustomParams": ""
|
Sample Response | { "PostId":”F50656781FFA45338C1F28499555A0BC” "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550 |
GetPostResult
URL | LIVE: https://api.relateddigital.com/resta/api/Post/GetPostResult?PostId=58D3A9E86C734F599BB87CBD87E3A531 ECOMM: https://api.relateddigital.com/reste/api/Post/GetPostResult?PostId=58D3A9E86C734F599BB87CBD87E3A531 LIVEM: https://api.relateddigital.com/restm/api/Post/GetPostResult?PostId=58D3A9E86C734F599BB87CBD87E3A531 |
|---|---|
Http verb | GET |
Parameters | PostId(string): ID of the post given by PostHtml web service. |
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login. |
Body |
|
Sample Body |
|
Sample Response | { "PostId": "58D3A9E86C734F599BB87CBD87E3A531", "RelayStatus": "R", "DeliveryStatus": "RE", "UndeliveryReason": "", "MarkedSpam": false, "KeyId": "", "CustomParams": "", "PostType": "rest_type", "ReadTime": "", "RelayBounceTime": "", "LastUpdateTime": "", "FromAdress": null, "Subject": null, "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "63259CB6EE6543219A4E37575A94655F" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01, 26, 99 |
GetPostBulkBounceResult
URL | LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkBounceResult ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkBounceResult LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkBounceResult LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkBounceResult |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login. |
Body |
|
Sample Body | { "BeginDate": "sample string 1", "EndDate": "sample string 2" } |
Sample Response | { "Success": false, "Errors": [ "TransactionId": "" |
Succcess Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550 |
GetPostBulkResult
URL | LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResult ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResult LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResult LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResult |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login. |
Body |
|
Sample Body | { "BeginDate": "sample string 1", "EndDate": "sample string 2" } |
Sample Response | { "Success": false, "Errors": [ "Message": "" "TransactionId": "" |
Succcess Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |