Bu döküman hala kullanımda olan eski XML web servisleri için yazılmıştır. 2019 yılında yeni web servisi yayınlanmıştır. Yeni Postatr APİ & JSON web servisi dökümanı için tıklayın.
Nedir ?
Sistemde kayıtlı olan üyelerinize Postatr.com kullanıcı paneline girmeden email kampanyaları başlatmanız için kullanabileceğiniz bir web servisidir.
En az 1 adet aylık hesabı olan sözleşmeli müşterilerimiz bu servisi kullanmak için yetki isteyebilirler.
Bağlantı URL ?
http://campmanager.postatr.com/CampaignStarter.asmx
Metodlar ve kullanımları
-
Authenticate
Açıklamalar
Web servisinde bulunan metodların kullanılması için öncelikle yetki kodu almanız gerekir. Bu metodu kullanarak Postatr servisine kayıt olurken kullandığınız kullanıcı adı ve şifre bilgileri ile birlikte Şifreli numaranızı girerek diğer metodlar için kullanacağınız yetki kodunu edinebilirsiniz.Edindiğiniz yetki kodu 10 dakika süresince geçerli olacaktır.
Parametreler
Username : Postatr sistemine giriş için kullandığınız kullanıcı adı
Password : Postatr sistemine giriş için kullandığınız şifre
EncryptedId : Postatr sisteminde tanımlı ve şifrelenmiş bulten numarasıdır, Eğer bilmiyorsanız yetkililerimizle iletişime geçebilirsiniz.
Dönen Cevaplar
Bilgiler doğru ise yetki kodu döner
<string>6AC778A1-10D5-4EE5-A95A-22CBE9431085</string>
Bilgiler yanlış ise 0 döner
<string>00000000-0000-0000-0000-000000000000</string>
-
EmailCamp_SenderList
Açıklamalar
Kayıt olduğunuzda 1 adet varsayılan gönderen hesabınız tanımlayabilirsiniz. Ek gönderen hesapları için iletişime geçiniz.
Parametreler
Token : Authenticate metodunu kullanarak almış olduğunuz yetki kodu
Dönen Cevaplar
Bilgiler doğru ise gönderen hesabı bilgileriniz döner."SenderId" değeri email kampanyalarınızı başlatmak için gereklidir. Varsayılan SenderId 0 'dır.
-
EmailCamp_Start
Açıklamalar
Email kampanyanızı başlatmak için bu metodu kullanabilirsiniz.
Parametreler
- Token (Authenticate metodunu kullanarak almış olduğunuz yetki kodu)
- SegmentationFilter
SQL dilinde kullanılan “Where” ifadesinin karşılığıdır. Veritabanında kayıtlı bulunan ve süzme yetkinizin bulunduğu tüm alanları kullanabilirsiniz.
Bir kriter yazmazsanız hata verir.
Örnek 1 : (Email adresi içerisinde "@postatr.com" geçen tüm üyelere)
Email Like '%@postatr.com%'
Örnek 2 : (Sadece abc@postatr.com email adresli üyeye)
Email = 'abc@postatr.com'
Örnek 3 : (abc@postatr.com ve def@postatr.com email adresli üyelere )
Email = 'abc@postatr.com' Or Email = 'def@postatr.com'
Örnek 4 : (TestGrup alanı içerisindeki verisi “Evet” olanları seçer)
TestGrup= 'Evet'
Örnek 5 : (Kendi tanımladığınız veritabanı alanında kendi girdiğiniz değeri süzün)
VeritabanıAlanınız = 'Alana girdiğiniz değer'
Örnek 6 : (Tüm kayıtlı ve aktif olan üyelerinizi süzün)
1=1 ve ya Email Like '%@%'
- CampDescription (Sadece sizin göreceğiniz kampanya açıklaması )
- ExMail
Test mail adresidir. Servis kullanımı için düzenlemelerinizi yaparken, HTML kodlarınızı ve farklı sağlayıcılardaki görüntüsünü test ederken kullanabilirsiniz.Ayrıca gerçek kampanyanızı başlatmadan önce son bir test yapmak ve onaylandıktan sonra gerçek hedef kitlesine başlatmak için kullanabilirsiniz.
1. Eğer bu alanda bir bilgi girilmiş ise SegmentationFilter değerine bakılmaksızın sadece bu adrese email gönderimi yapılacaktır.
2. Eğer bu alanda bir bilgi girilmiş ise Zamanlayıcı devre dışı kalacak ve bu email adresine hemen 1 adet email gönderilecektir.
- CampDate (Kampanyanızın başlama tarihidir, boş ve ya geçmiş bir tarih geçerseniz hemen başlatır.
Format :
27.01.2018 14:07
)
- MailType (Artık sadece HTML tipinde mail gönderiyoruz. Boş geçiniz.)
- Subject (Mail kampanyanızın konusu)
- MailBody (Mail kampanyanızın HTML kodları)
HTML kodlarınız üyelikten ayrılma linki içermek zorundadır.
- SenderId (Gönderen hesaplarınız arasında seçim yapabilirsiniz.Varsayılan gönderen hesabınız 0 dır.)
Dönen Cevaplar
Eğer bilgiler geçerliyse kampanya başlamak üzere ayarlanır ve geriye kampanya numarası döner
<int>18801</int>
-
Reports_CampaignReports
Açıklamalar
Size ait olan bir kampanyayı raporlamak için kullanabilirsiniz.Kampanya alıcısı olan her email ile birlikte gönderim tarihi, ulaşım durumu, açılma sayısını ve son açılma tarihini gösterir.
Parametreler
Token : Authenticate metodunu kullanarak almış olduğunuz yetki kodu
CampId : Kampanyanızın Postatr numarasıdır, Kampanyayı başlattığınızda bu numara üretilerek size döndürülür. Daha detaylı bilgi için EmailCamp_Start metodunu inceleyebilirsiniz.
Dönen Cevaplar
İşlem başarılı ise her email adresi ile birlikte durum bilgisi döndürür.
O = Ok (Gönderildi, Şimdilik sorun yok)
K = Kuyrukta(Birazdan gönderilecek)
S = Soft Bounce (Henüz ulaşmadı ama sistem tekrar deneyecek, Bir süre sonra eğer alıcıda bir sorun yoksa ulaştıracaktır.)
H = Hard Bounce (Kalıcı problem olup hata anlamındadır. Tekrar denenmez ve mailin ulaşmadığı sonucunu çıkarabilirsiniz.)
İşlem başarısız ise
<string>ERR: {Hatanın Açıklaması}</string>
-
Reports_CampaignDetails
Açıklamalar
Eğer CampId=KampanyaNumarası parametre olarak geçerseniz o kampanyaya ait özet bilgileri gösterir. CampId=0 geçerseniz son 100 kampanyanızın özet bilgilerini.
Parametreler
Token : Authenticate metodunu kullanarak almış olduğunuz yetki kodu
CampId : Kampanyanızın Postatr numarasıdır, Kampanyayı başlattığınızda bu numara üretilerek size döndürülür. Daha detaylı bilgi için EmailCamp_Start metodunu inceleyebilirsiniz. Eğer 0 geçerseniz son 100 kampanyanıza ait detayları gösterir.
Dönen Cevaplar
İşlem başarılı ise
İşlem başarısız ise
<string>ERR: {Hatanın Açıklaması}</string>
-
Hata kodları
Açıklamalar
ihtiyaç duyabileceğiniz bazı hata kodlarını aşağıda görüntüleyebilirsiniz.
1 : Login veya Token Geçersiz
2 : Yetkisiz Kullanıcı
3 : Çıkış linki bulunamadı
4 : Segmentationfilter bu şekilde kullanılamaz
5 : Kayıtlı filtre bulunamadı
7 : Segmentationfilter boş olamaz
9 : Kampanya başlatılamıyor. Lütfen parametreleri kontrol ediniz.
18 : İşlemleriniz doğru yapıldı ama kampanya başlatılamadı. Belirttiğiniz kriterde kayıt bulunamıyor. SegmentationFilter alanınız sonuç üretmiyor.
19 : Kampanya başlatmak için veriler uygun değil
40 : Kampanya yok veya henüz işlenmedi
41 : Bu kampanya bilgilerine erişim yetkiniz yok.
42 : Kampanya detaylarına ulaşılamıyor.
49 : Kampanya bilgileri alınamıyor
71 : Mail Subject bulunamadı
72 : Mail Subject çok kısa
80 : Hiç kayıtlı gönderen hesabı yok
81 : Gönderen hesapları alınamıyor
82 : SenderId tamsayı olmalıdır.
83 : Bu gönderen hesabını kullanamazsınız.
91 : Bu kullanıcı belirtilen işlemi yapamıyor.
92 : Bu email adresi belirtilen işlemi yapamıyor.
93 : En fazla 50 adet üyeyi aynı anda raporlayabilirsiniz.
95 : Bu JSON dosyayı çözülemiyor. Serileştirme işleminizi kontrol edin.
96 : Bu JSON dosyayındaki üyeler alınamıyor. Serileştirme işleminizi kontrol edin.
97 : Bu JSON dosyayından hiç bir üye eklenmedi & güncellenmedi.
101 : ProcessType alanı hatalı veya hiç gönderilmemiş. Gönderilen bilgilerle ne yapılacağı anlaşılmıyor.
102 : ProcessType alanı gönderilmiş ancak karşılığı tanımsız. "DataOnly", "ThisOnly", "AllDatabase" geçmelisiniz.
Bu döküman kampanya yönetimi web servisi kullanım bilgilerini içerir. Data yönetimi web servisi için
burayı tıklayınız.