16
Kas

Postatr APİ & JSON web servisi

Postatr APİ & JSON web servisi



Nedir ?

Sistemde kayıtlı olan üyelerinize Postatr.com kullanıcı paneline girmeden uzaktan datalarınızın yönetimi, veritabanı eşleme, uygulama entegrasyonu, toplu, tekil veya transactional mail gönderileriniz için kullanabileceğiniz gelişmiş bir web servisidir.

En az 1 adet aylık hesabı olan sözleşmeli müşterilerimiz bu servisi kullanmak için yetki isteyebilirler. IP adresiniz için yetki almadan bu servise erişemezsiniz.

Bağlantı URL ?

http://api.postatr.com/api.asmx

Metodların tek tek kullanımları ?


  • Authenticate
  • 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 ve kullanım
    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ş hesap numarasıdır.


    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>

  • ReportCampaign
  • Daha önceden göndermiş olduğunuz bir kampanyanın detaylarına veya şimdiye kadar gönderdiğiniz tüm kampanyaların genel bilgilerine ulaşın.

    Parametreler ve kullanım
    Token : Authenticate metodunu kullanarak almış olduğunuz yetki kodu
    CampId : Kampanyanızın Postatr numarasıdır, bir kampanyayı başlattığınızda bu numara üretilerek size döndürülür.


  • ReportMembers
  • Bir kampanyanın alıcılarını raporlar. Açma, tıklama, ulaşma bilgilerini ve tarihlerini döndürür.

    Parametreler ve kullanım
    Token : Authenticate metodunu kullanarak almış olduğunuz yetki kodu
    CampId : Kampanyanızın Postatr numarasıdır, bir kampanyayı başlattığınızda bu numara üretilerek size döndürülür.
    MemberId : Üyenizin sizde kayıtlı firma numarası. Göndermezseniz kampanyadaki tüm alıcıları raporlar.


  • StartProcess
  • Tüm işlemleri yapacak olan metoddur.

    Parametreler ve kullanım
    • 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 '%@%'

    • MailDescription (Sadece sizin göreceğiniz kampanya açıklaması )
    • MailTestAddress
    • 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.

    • StartDate (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.)
    • MailSubject (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.)
    • MemberGroups
    • Üyelerinizi eklerken veya süzerken başka amaçlar için kullanmak üzere ayırır yani gruplarsınız. Her grubun bir numarası olur ve numaraları grubu oluşturduğunuz zaman edinirsiniz. Buraya grup numaralarını virgül "," ile ayırarak "1354, 1359, 1648" şeklinde geçerek hedef kitlenizi gruplara özel belirleyebilirsiniz.Kolaylaştırmak için eklenmiş ve zorunlu olmayan bu metoda "0" sıfır geçerek yok sayabilirsiniz.

    • ProcessType
    • 3 farklı veriyi kabul eder
      1.DataOnly: Sadece bu gönderdiğiniz json dosyasındaki datalar üzerinde işlem yap.Kampanya gönderme.
      2.ThisOnly: Sadece bu gönderdiğiniz json dosyasındaki datalara kampanya gönder.
      3.AllDatabase: Bu gönderdiğiniz json dosyasındaki dataları işler ve daha sonra SegmentationFilter alanındaki süzme işleminize göre tüm database alıcılarını süzerek kampanya gönderir.

    • Listid
    • Gönderdiğiniz her dataya bir listid numarası atayın. Bu şekilde her datayı ayrı ayrı veya farklı zamanlarda birleştirmek üzere gruplayabilirsiniz.


    Örnek: Aşağıdaki Örnek JSON'u post ettiğinizde üyelerinizi ekler&günceller, gruplar&gruba dahil eder, email kampanyasını başlatır ve size bilgilerini döndürür.



    Hata kodları

    ihtiyaç duyabileceğiniz bazı hata kodlarını aşağıda görüntüleyebilirsiniz. Burada olmayan bir hata alıyorsanız lütfen iletişime geçin.

    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 : Çok fazla sayıda üyeyi aynı anda raporlamaya çalışıyorsunuz.
    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.

  

 Comments (0)

       Leave A Comment

    yorumlarda görünecektir

    paylaşılmaz, görüntülenmez

    max 1500

    Kampanya, duyuru, bilgilendirme veya yeni bloglar için mail gönderebilirsiniz (Postatr müşterilerini kapsamaz & mail adresiniz sadece postatr.com firmasına özel mailler için kullanılır.)