E-SMM belgesini özel entegratör sistemlerine gönderilmesini sağlayan servistir. Bu servis ile gönderilen belgeler kuyruğa eklenerek işleme (imzalama, e-posta/sms gönderme ve raporlama) alınacaktır.
- Eğer müşterinin özel entegratör ile e-posta gönderme hizmeti sözleşmesi yoksa ve webservis isteğinde e-posta gönderme seçeneği seçilmişse işlem hata alacaktır. Bu durumda özel entegratör ile iletişime geçerek e-posta gönderim hizmeti sözleşmesi imzalanmalı ve e-posta gönderim hizmetinin aktiflemesi talep edilmelidir. Eğer e-posta gönderimi farklı kanallardan yapılacaksa e-posta gönderim parametresini N olarak gönderiniz.
Parametreler
| Ad | Tip | Zorunlu | Aciklama |
|---|---|---|---|
REQUEST_HEADER |
object |
Evet | |
└ SESSION_ID |
text |
Evet | Kimlik doğrulama servisi (AuthenticationWS) oturum açma metodundan (Login) alına oturum/token/session bilgisi. |
└ CLIENT_TXN_ID |
text |
Hayir | İstemci uygulama tarafından işlem için üretilen işlem bilgisi (transaction id) varsa istek esnasında gönderilip, sonuçta alabileceğiniz bir değerdir. request/response eşleşmesi yapmak için kullanılabilir. |
└ APPLICATION_NAME |
text |
Evet | Metodu çağıran uygulamanın adı. Örnek: AppName-v1.4.67 |
└ COMPRESSED |
text |
Hayir | İçerikte taşınan bilginin ZIP formatında sıkıştırılmış mı gönderildiği/talep edildiği bilgisi. Belge gönderim ve belge okuma servislerinde gönderilen değere göre işlem yapılmaktadır. |
SMM |
object |
Evet | En az bir SMM elementi bulunmalıdır. Toplu SMM göndermek bu eleman çoklanır. Atanan belge numarası ID attribute içerisine, Evrensel tekil tanımlama numarasını (ETTN) UUID attribute eklenmek zorundadır. |
└ CONTENT |
base64 |
Evet | Belgenin Base64Binary olarak encode edilmiş XML veya Ziplenmiş içeriği. XML formatında sıkıştırılmadan göndermek için mutlaka COMPRESSED elemanı eklenmeli ve N değeri gönderilmelidir. Daha hızlı iletişim sağlamak için belgelerin sıkıştırılarak gönderilmesini öneriyoruz. |
SMM_PROPERTIES |
object |
Hayir | SMM belgesi ile ilgili parametrelerin belirlendiği elemandır. Belgenin alıcısına e-posta veya SMS olarak iletme isteği belirlenebilir. |
└ SMS_FLAG |
text |
Hayir | Belge alıcısına SMS olarak göndermek için Y değeri gönderilmelidir. Eleman gönderilmezse SMS_NUMBER dolu olsa dahi SMS gönderilmez. DİKKAT: Eğer müşterinin özel entegratör ile SMS gönderme hizmeti sözleşmesi yoksa ve Y değeri gönderilirse belgenin sisteme yüklenmesine izin verilmeyecektir. Bu durumda özel entegratör ile iletişime geçerek SMS gönderim hizmeti satın alınmalı veya SMS gönderiminin farklı bir kanaldan müşteri tarafından yapılması gerekmektedir. Bu durumda bu parametre gönderilmemeli veya N olarak gönderilmelidir. |
└ SMS_NUMBER |
text |
Hayir | Belgenin SMS olarak iletileceği telefon numarası. Eğer SMS_FLAG elemanına Y gönderilirse bu alan zorunludur. SMS_FLAG elemanı Y gönderilmezse bu elaman dolu olsa dahi SMS gönderilmez. |
└ EMAIL_FLAG |
text |
Hayir | Belge alıcısına e-posta olarak gönderilip gönderilmeyeceğinin belirlendiği parametredir. E-Posta göndermek istenilen durumda Y değeri gönderilmelidir. Eleman gönderilmezse EMAIL alanı dolu olsa dahi e-posta gönderilmez. DİKKAT: Eğer müşterinin özel entegratör ile e-posta gönderme hizmeti sözleşmesi yoksa ve Y değeri gönderilirse belgenin sisteme yüklenmesine izin verilmeyecektir. Bu durumda özel entegratör ile iletişime geçerek e-posta gönderim hizmeti satın alınmalı veya e-posta gönderiminin farklı bir kanaldan müşteri tarafından yapılması gerekmektedir. Bu durumda bu parametre gönderilmemeli veya N olarak gönderilmelidir. |
└ EMAIL |
text |
Hayir | Belgenin e-posta olarak iletileceği e-posta adresi. E-Posta formatında olmak zorundadır. E-Posta gönderimini özel entegratör sisteminden yapılması isteniyorsa Y değeri gönderilmelidir. Varsayılan değer N dir. EMAIL_FLAG alanı Y gönderildiği zaman bu elaman zorunludur. EMAIL_FLAG gönderilmemiş veya N değeri gönderilmişse bu elaman dolu olsa dahi e-posta gönderilmeyecektir. |
└ SENDING_TYPE |
select |
Evet | Belgenin yollanma şekli. ELEKTRONIK veya KAGIT olabilir. Gönderim şekli ELEKTRONIK olan belge SMS veya ePosta adresi olmak zorundadır |
SERIES_PROPERTIES |
object |
Hayir | Belge numarasının özel entegratör tarafından atanmasının belirleyen parametredir. Belge numarasının istemci tarafından atanmasını tavsiye ederiz. |
└ SERIES_FLAG |
select |
Hayir | Belge numarasının özel entegratör tarafından atanması için Y değeri gönderilmelidir. DİKKAT: SERIES_PREFIX elemanında belirlenen ön ek ile belge numarası atanacak ve belge içerisinde ki değer ezilecektir. |
└ SERIES_PREFIX |
text |
Hayir | Belge numarası atanacak ön ek. 3 hane alfanumerik değer içermelidir. Belge numarası yönetimi hakkında daha detaylı bilgi almak için Başlarken -> Belge Numarası Yönetimi başlığını inceleyiniz. Belge numarasının özel entegratör tarafından atanması için Y değeri gönderilmelidir. DİKKAT: SERIES_FLAG elemanı Y değeri gönderilmemişse bu alan dolu olsa dahi belge numarası atanmayacaktır. |