MailTech Dev

BAŞLANGIÇ

Giriş

MailTech API RESTful prensiplerine göre çalışır.

GET /v1

GÜVENLİK VE AUTH

API Key Doğrulama

Header'daki X-API-Key bilgisini doğrular.

GET /v1/status

E-POSTA SERVİSLERİ

Anlık Mail Gönder

Hızlı e-posta gönderimi sağlar.

POST /v1/send-mail

WEB FORMLAR VE ANKETLER

Formları Listele

Kullanıcıya ait tüm web formları ve anketleri listeler.

GET /webform/webform_api.php?action=list

Form Yanıtlarını Çek

Belirli bir form veya anket için doldurulan tüm verileri JSON olarak döner.

GET /webform/webform_api.php?action=submissions

Form İstatistikleri

Formun görüntülenme ve doldurulma oranlarını (conversion rate) döner.

GET /webform/webform_api.php?action=stats

Programatik Form Oluştur

Kendi uygulamanız üzerinden yeni bir web form veya anket tasarımı oluşturmanızı sağlar.

POST /webform/webform_api.php?action=save

KAMPANYA VE ANALİZ

Kampanyaları Listele

Kampanya geçmişini döner.

GET /v1/get-campaigns

Kişiler ve Segmentler

Listeleri Getir

Kullanıcının kişi listelerini ve kişi sayılarını döndürür.

GET /v1/get-lists

Kişi Ekle/Güncelle

Bir listeye kişi ekler, varsa günceller ve custom field değerlerini işler.

POST /v1/add-contact
Parametre Tip Durum Açıklama
email string/email Zorunlu Eklenecek e-posta adresi
list_id integer Zorunlu Hedef liste ID
custom_fields object Opsiyonel Alan adı => değer eşleşmesi

Segmentleri Getir

Kullanıcının segmentlerini listeler.

GET /v1/get-segments

Tag Ekle

E-posta adresine tag atar ve otomasyon motorunu bilgilendirir.

POST /v1/add-tag
Parametre Tip Durum Açıklama
email string/email Zorunlu Abone e-postası
tag_id integer Zorunlu Tag ID

Tag Kaldır

E-posta adresinden tag ilişkisini kaldırır.

POST /v1/remove-tag
Parametre Tip Durum Açıklama
email string/email Zorunlu Abone e-postası
tag_id integer Zorunlu Tag ID

Contact Listeleri

Sayfalı olarak contact listelerini ve toplam kişi sayılarını döndürür.

GET /v1/contact-lists
Parametre Tip Durum Açıklama
limit integer Opsiyonel Maksimum 100
offset integer Opsiyonel Varsayılan 0

Contact List Detay

Liste detayını ve bağlı custom field tanımlarını getirir.

GET /v1/contact-lists/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Liste ID

Contact List Oluştur

Yeni contact listesi oluşturur ve isteğe bağlı custom field IDlerini bağlar.

POST /v1/contact-lists
Parametre Tip Durum Açıklama
name string Zorunlu Liste adı
owner_email email Opsiyonel Gönderen e-posta
reply_email email Opsiyonel Yanıt adresi

Contact List Güncelle

Liste adı, gönderen bilgileri ve custom field bağlantılarını günceller.

PUT /v1/contact-lists/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Liste ID

Contact List Sil

Listeyi, kişilerini, custom field değerlerini ve tag bağlantılarını siler.

DELETE /v1/contact-lists/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Liste ID

Contact Listele

Kişileri liste, e-posta araması ve sayfalama ile döndürür.

GET /v1/contacts
Parametre Tip Durum Açıklama
list_id integer Opsiyonel Liste filtresi
email string Opsiyonel E-posta araması
limit integer Opsiyonel Maksimum 100

Contact Detay

Kişi detayını ve custom field değerlerini getirir.

GET /v1/contacts/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Kişi ID

Contact Oluştur/Güncelle

REST formatında kişi oluşturur; aynı e-posta listede varsa günceller.

POST /v1/contacts
Parametre Tip Durum Açıklama
email email Zorunlu E-posta
list_id integer Zorunlu Liste ID
custom_fields object Opsiyonel Alan adı/ID => değer

Contact Güncelle

Kişi e-postasını, listesini, unsubscribe durumunu ve custom field değerlerini günceller.

PUT /v1/contacts/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Kişi ID

Contact Sil

Kişiyi ve bağlı custom field/tag kayıtlarını siler.

DELETE /v1/contacts/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Kişi ID

Blacklist Listele

Kullanıcı kara listesini e-posta araması ve sayfalama ile döndürür.

GET /v1/blacklist
Parametre Tip Durum Açıklama
email string Opsiyonel E-posta araması
limit integer Opsiyonel Maksimum 100

Blacklist Ekle

E-postayı kara listeye alır ve kullanıcı listelerindeki kişiyi unsubscribe yapar.

POST /v1/blacklist
Parametre Tip Durum Açıklama
email email Zorunlu E-posta
reason string Opsiyonel Açıklama

Blacklist Çıkar

ID veya e-posta ile kara liste kaydını siler ve unsubscribe durumunu geri alır.

DELETE /v1/blacklist
Parametre Tip Durum Açıklama
id integer Opsiyonel Blacklist ID
email email Opsiyonel E-posta

Gönderim

Şablondan Mail Gönder

Kayıtlı newsletter şablonunu kişiselleştirerek tek alıcıya gönderim kuyruğu oluşturur.

POST /v1/send-template
Parametre Tip Durum Açıklama
to string/email Zorunlu Alıcı
template_id integer Zorunlu Newsletter ID
variables object Opsiyonel Kişiselleştirme değişkenleri

Kampanya Tetikle

Liste veya segment üzerinden kayıtlı newsletter için job/job_data oluşturur.

POST /v1/trigger-campaign
Parametre Tip Durum Açıklama
template_id integer Zorunlu Newsletter ID
list_id integer Opsiyonel Liste ID
segment_id integer Opsiyonel Segment ID

Kampanyalar ve İstatistikler

Kampanya İstatistikleri

Gönderim, bounce, açılma, tıklama, unsubscribe, reply ve geo özetini verir.

GET /v1/get-campaign-stats
Parametre Tip Durum Açıklama
job_id integer Zorunlu Job ID

Newsletter Şablonları

Kullanıcıya ait newsletter şablonlarını sayfalı döndürür.

GET /v1/newsletters
Parametre Tip Durum Açıklama
q string Opsiyonel Ad/konu araması
limit integer Opsiyonel Maksimum 100

Newsletter Detay

Newsletter konu, HTML ve A/B içerik detayını döndürür.

GET /v1/newsletters/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Newsletter ID

Webform Listele

Kullanıcıya ait webformları görüntülenme, gönderim ve yanıt sayılarıyla listeler.

GET /v1/webforms
Parametre Tip Durum Açıklama
limit integer Opsiyonel Maksimum 100
offset integer Opsiyonel Varsayılan 0

Webform Detay

Webform ayarları, tasarım JSONu ve public içerik detayını getirir.

GET /v1/webforms/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Webform ID

Webform Yanıtları

Webform yanıtlarını sayfalı döndürür; cevap JSONu answers alanında parse edilmiş gelir.

GET /v1/webforms/{id}/responses
Parametre Tip Durum Açıklama
id integer Zorunlu Webform ID
limit integer Opsiyonel Maksimum 200

Webform İstatistikleri

Günlük görüntülenme/gönderim, dönüşüm oranı ve alan bazlı cevap dağılımlarını verir.

GET /v1/webforms/{id}/stats
Parametre Tip Durum Açıklama
id integer Zorunlu Webform ID
days integer Opsiyonel 1-365 arası

Anket Listele

Kullanıcıya ait anketleri görüntülenme, cevap ve tamamlanma oranıyla listeler.

GET /v1/surveys
Parametre Tip Durum Açıklama
limit integer Opsiyonel Maksimum 100
offset integer Opsiyonel Varsayılan 0

Anket Detay

Anket ayarları, soru JSONu ve HTML tasarım detayını getirir.

GET /v1/surveys/{id}
Parametre Tip Durum Açıklama
id integer Zorunlu Anket ID

Anket Yanıtları

Anket yanıtlarını sayfalı döndürür; kampanya/subscriber takip IDleri dahil gelir.

GET /v1/surveys/{id}/responses
Parametre Tip Durum Açıklama
id integer Zorunlu Anket ID
limit integer Opsiyonel Maksimum 200

Anket İstatistikleri

Günlük view/complete, tamamlanma oranı, soru bazlı dağılım ve kampanya kırılımını verir.

GET /v1/surveys/{id}/stats
Parametre Tip Durum Açıklama
id integer Zorunlu Anket ID
days integer Opsiyonel 1-365 arası

Webhooklar

Webhookları Getir

Kayıtlı API webhooklarını listeler.

GET /v1/get-webhooks

Webhook Ekle

unsubscribe, bounce veya click olayı için webhook kaydeder.

POST /v1/add-webhook
Parametre Tip Durum Açıklama
event_type enum Zorunlu unsubscribe, bounce, click
url url Zorunlu HTTPS webhook URL

Webhook Sil

ID ile webhook kaydını siler.

DELETE /v1/delete-webhook
Parametre Tip Durum Açıklama
id integer Zorunlu Webhook ID

Sistem

Kuyruk Durumu

BAPI kuyruk istatistiklerini döndürür. Bu endpoint admin panel içindir ve HMAC token gerektirir.

GET /status.php
Parametre Tip Durum Açıklama
token string Zorunlu Admin panel tarafından üretilen HMAC token

Kapsam Notları

Kapsam Özeti

Developer portal public BAPI özelliklerini belgeler. Phase 2 ile webform ve anket yanıt/istatistik okuma endpointleri eklenmiştir.