Anchor | ||||
---|---|---|---|---|
|
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 |
---|---|
431292513CreateTransactionalEmailTemplate | |
431292513GetPostBulkBounceResult | İki tarih aralığında geçersiz yada ulaşmayan adres olarak raporlanan transactional e-postaları sorgular. |
431292513GetPostBulkResult | İki tarih aralığında gönderilen transactional e-postaların durumunu sorgular. |
431292513GetPostBulkResultByLastUpdate | İki tarih aralığında ulaşım durumu değişmiş (okunmuş, geçersiz raporlanmış vb.) transactional e-postaları sorgular. |
431292513GetPostBulkResultByPostId | Girilen PostID’lere ilişkin e-postaların durumunu sorgular. |
431292513GetPostBulkResultWithOptional | Kampanya Tipi veya Gönderen Adreslerden biri belirtilerektransactional e-postaların durumunu sorgular. |
431292513GetPostResult | Gönderilen bir transactional e-postanın durumunu sorgular. |
PostHtml | Bir adrese transactional bir e-posta gönderilmesini sağlar. |
431292513PostHtmlWithTypeCCandBCC | Bir adrese, CC ve BCC ekleyerek transactional bir e-posta gönderilmesini sağlar. |
431292513PostTransactionalEmailWithHtmlTemplate | Hesabınızda tanımlı bir HTML şablonu bir e-posta adresine gönderebilmenizi sağlar. |
431292513PostTransactionalEmailWithXsltTemplate | Hesabınızda tanımlı bir XSLT şablonu bir e-posta adresine gönderebilmenizi sağlar. |
PostWithTemplate |
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 Anchor CreateTransactionalEmailTemplate CreateTransactionalEmailTemplate
CreateTransactionalEmailTemplate | |
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
Anchor | ||||
---|---|---|---|---|
|
Widget Connector width 960 url https://www.youtube.com/watch?v=zDrVM6QB4iA height 540
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 AnchorPostHtmlWithTypeCCandBCC PostHtmlWithTypeCCandBCC
PostHtmlWithTypeCCandBCC | |
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 AnchorGetPostResult GetPostResult
GetPostResult | |
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 AnchorGetPostBulkBounceResult GetPostBulkBounceResult
GetPostBulkBounceResult | |
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 AnchorGetPostBulkResult GetPostBulkResult
GetPostBulkResult | |
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 | 00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550 |
GetPostBulkResultByLastUpdate AnchorGetPostBulkResultByLastUpdate GetPostBulkResultByLastUpdate
GetPostBulkResultByLastUpdate | |
GetPostBulkResultByLastUpdate |
URL | LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResultByLastUpdate ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResultByLastUpdate LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResultByLastUpdate LIVEM : https://api.relateddigital.com/restm/api/post/GetPostBulkResultByLastUpdate |
---|---|
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 | 00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550 |
GetPostBulkResultByPostId AnchorGetPostBulkResultByPostId GetPostBulkResultByPostId
GetPostBulkResultByPostId | |
GetPostBulkResultByPostId |
URL | LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResultByPostId ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResultByPostId LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResultByPostId LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResultByPostId |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login. |
Body | |
Sample Body | { "PostIds": [ "sample string 1", "sample string 2" ] } |
Sample Response | { |
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 |
GetPostBulkResultWithCustomParams AnchorGetPostBulkResultWithCustomParams GetPostBulkResultWithCustomParams
GetPostBulkResultWithCustomParams | |
GetPostBulkResultWithCustomParams |
URL | LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResultWithCustomParams ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResultWithCustomParams LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResultWithCustomParams LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResultWithCustomParams |
---|---|
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", "CustomParams": "sample string 3" } |
Sample Response | { "Success": false, "Errors": [ { "Message": "" "DetailedMessage": "" |
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 |
GetPostBulkResultWithOptional AnchorGetPostBulkResultWithOptional GetPostBulkResultWithOptional
GetPostBulkResultWithOptional | |
GetPostBulkResultWithOptional |
URL | LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResultWithOptional ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResultWithOptional LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResultWithOptional LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResultWithOptional |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login |
Body | ToEmailAddress (string): Email address of the receiver PostType(string): Optional parameter.Type of email (account activation, survey, etc.) |
Sample Body | { "BeginDate": "sample string 1", "EndDate": "sample string 2", "PostType": "sample string 3", "ToAddresss": "sample string 4" } |
Sample Response | { "Success": false, "Errors": [ "Message": "" "DetailedMessage": "" |
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 |
PostTransactionalEmailWithHtmlTemplate AnchorPostTransactionalEmailWithHtmlTemplate PostTransactionalEmailWithHtmlTemplate
PostTransactionalEmailWithHtmlTemplate | |
PostTransactionalEmailWithHtmlTemplate |
URL | LIVE: https://api.relateddigital.com/resta/api/post/PostTransactionalEmailWithHtmlTemplate ECOMM: https://api.relateddigital.com/reste/api/post/PostTransactionalEmailWithHtmlTemplate LIVEB: https://api.relateddigital.com/liveb_rest/api/post/PostTransactionalEmailWithHtmlTemplate LIVEM: https://api.relateddigital.com/restm/api/post/PostTransactionalEmailWithHtmlTemplate |
---|---|
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(byte[]): Contents of file. |
Sample Body | { "FromName": "sample string 1", "FromAddress": "sample string 2", "ReplyAddress": "sample string 3", "TemplateName": "sample string 4", "SubjectVariables": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ], "BodyVariables": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ], "Charset": "sample string 5", "ToName": "sample string 6", "ToEmailAddress": "sample string 7", "Attachments": [ { "Name": "sample string 1", "Type": "sample string 2", "Content": "QEA=" }, { "Name": "sample string 1", "Type": "sample string 2", "Content": "QEA=" } ] } |
Sample Response | { "Success": false, "Errors": [ "Message": "" "DetailedMessage": "" |
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 |
PostTransactionalEmailWithXsltTemplate AnchorPostTransactionalEmailWithXsltTemplate PostTransactionalEmailWithXsltTemplate
PostTransactionalEmailWithXsltTemplate | |
PostTransactionalEmailWithXsltTemplate |
URL | LIVE: https://api.relateddigital.com/resta/api/post/PostTransactionalEmailWithXsltTemplate ECOMM: https://api.relateddigital.com/reste/api/post/PostTransactionalEmailWithXsltTemplate LIVEB: https://api.relateddigital.com/liveb_rest/api/post/PostTransactionalEmailWithXsltTemplate LIVEM: https://api.relateddigital.com/restm/api/post/PostTransactionalEmailWithXsltTemplate |
---|---|
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(byte[]): Contents of file. |
Sample Body | { "FromName": "sample string 1", "FromAddress": "sample string 2", "ReplyAddress": "sample string 3", "TemplateName": "sample string 4", "Xml": "sample string 5", "Charset": "sample string 6", "ToName": "sample string 7", "ToEmailAddress": "sample string 8", "Attachments": [ { "Name": "sample string 1", "Type": "sample string 2", "Content": "QEA=" }, { "Name": "sample string 1", "Type": "sample string 2", "Content": "QEA=" } ] } |
Sample Response | { "Success": false, "Errors": [ { "Message": "" "DetailedMessage": "" |
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 |
PostWithTemplate
Anchor | ||||
---|---|---|---|---|
|
URL | |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login. |
Body | JsonModel: içerisine, tanımlanan Transactional HTML'lerde verilen değişkenler uygun şekilde girilmeli. StrictVariables : false girilirse Template içerisinde tanımlanan değişkenler request içerisine girilmese bile template'deki o değerler boş olarak gönderilir. true girilirse Template içerisinde tanımlanan değişkenlerin tamamı request içerisinde tanımlanmalı, aksi taktirde request hatalı response döner. |
Sample Body | { "TemplateName": "Sample_Template_Name", "JsonModel": { "subject": "Sample_subject", "data": { } }, "StrictVariables": false, "FromName": "Sample_from_name", "FromAddress": "Sample_from_address", "ReplyAddress": "Sample_reply_address", "Charset": "utf-8", "ToName": "Sample_to_name", "ToEmailAddress": "Sample_to_address" } |
Sample Response | |
Succcess Response | Status Code: 200 |
http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
Ana Sayfa: RMC REST API