| HTTP-HTTPS API Kullanım Kılavuzunu indirmek için TIKLAYINIZ! |
Genel
HTTP/HTTPS API, Toplu SMS gönderim hizmetimizi kullanmak isteyen ve SMS gönderim gereksinimleri bir seferde 150 adedi geçmeyen yazılım geliştiricilerin, kullanmakta oldukları yazılım geliştirme ortamlarıyla SMS modülünü entegre edebilmelerini sağlamak amacıyla geliştirilmiştir.
Mobildev HTTP/HTTPS API, uygulama geliştiricilerin, çözümlerine SMS teknolojisini eklemeleri için, HTTP ya da HTTPS üzerinden Mobildev SMS Gateway’a ulaşmalarını sağlar. Yazılım geliştiriciler, Mobildev HTTP/HTTPS tarafından sunulan yöntemleri, belirtilen şekilde kullanarak çağırırlar. Sunulan yöntemler HTTP API ve HTTPS API için de aynıdır. Farklı olan kısımları parametrelerin gönderildiği adreslerdir. Bunlar aşağıda yer alan şekildedir ve her iki adres de Gateway olarak anılacaktır.
Hazırladığınız SMS gönderim formlarının action parametresine yukarıdaki adreslerden size uygun olanını ekleyerek SMS gönderimleri yapabilirsiniz. Gönderim yapacağınız formun metot parametresinin değeri POST olmalıdır.
Unutmayın: HTTP/HTTPS sayesinde veri, internet üzerinden iletilmeden önce şifrelenir böylece verilerin başkaları tarafından dinlenmesi engellenmiş olur. |
Sistem Gereksinimleri
Mobildev HTTP/HTTPS API çözümünü kullanabilmeniz için gereken minimum sistem gereksinimleri aşağıda belirtilmiştir.
-
Windows 98 SE, ME, 2000, XP, UNIX, Linux ya da MacOS İşletim Sistemi
-
Internet Explorer 6 SP1 (Windows Platformu için)
Kullanıcı Bilgilerinin Kontrolü
SMS gönderimine başlamadan önce SMS kullanıcı bilgilerinin kontrolü sağlanmalıdır. Mevcut SMS hesabınız bulunmuyorsa test hesabı almak için için TIKLAYINIZ.
Gateway'e yollanan kullanıcı bilgilerinin doğruluğu sistem tarafından kontrol edilerek kullanıcı hesabına ait kredi bilgisi ve orijinatör bilgisi sistem tarafından gönderilir. Kullanıcı bilgilerinin kontrolü sırasında Username, company, password ve action bilgileri kontrol edilir.
Username: Mobildev SMS hesabı üzerinde tanımlı kullanıcı adınızı ifade eder.
Company: SMS kullanıcı adınızın tanımlı olduğu kanal bilgisidir (client kodu olarak da adlandırılabilir).
Password: SMS kullanıcı adınıza ait şifreyi ifade eder.
Action: Gateway'e gönderilen HTTP/HTTPS ifadesinin hangi işlev için gönderildiğini rakamsal bazda ifade eden parametre düğümüdür. Kullanıcı bilgilerinin kontrolü için kullanılan Action parametresi 2'dir.
Gateway'e gönderilen bilgilerin kontrolü gerçekleştirildiğinde; bilgiler hatalıysa 01 Hata Kodu döner. Hata Kodu 01, Hatalı Kullanıcı Adı – Şifre – Bayi Kodu bilgilerinden birinin ya da tamamının hatalı olduğu anlamına gelir. Bu durumda Mobildev Teknik Destek Ekibi ile iletişime geçip bilgilerinizi kontrol etmelisiniz.
Gateway'e gönderilen bilgilerin kontrolü gerçekleştirildiğinde; bilgiler doğruysa aşağıdaki geri dönüş değerini alırsınız:
Kontör sayısı<10>
Originator1<10>
Originator2<10>
OriginatorN
HTTP için Kullanıcı Bilgileri Kontrolü URL İfadesi:
http://gateway.mobilus.net/gateway.asp?username=kullanıcı adı&company=clientcode&password=parola&action=action değeri
HTTP için Kullanıcı Bilgileri Kontrolü Örnek URL İfadesi:
http://gateway.mobilus.net/gateway.asp?username=test&company=mb1000&password=1234&action=2
HTTPS için Kullanıcı Bilgileri Kontrolü URL İfadesi:
https://secure.mobilus.net/sms/gateway.asp?username=kullanıcıadı&company=clientcode&password=parola&action=action değeri
HTTPS için Kullanıcı Bilgileri Kontrolü Örnek URL İfadesi:
http://secure.mobilus.net/gateway.asp?username=test&company=mb1000&password=1234&action=2
Unutmayın: mb1000 değeri örnek olması açısından kullanılmıştır. Kullanıcı hesabınızın tanımlı olduğu Client Kodu, Kullanıcı Adı ve Parola bilgilerini girmelisiniz. |
Kullanılacak Karakterlere İlişkin Uyarılar
Gönderim sırasında;
-
Türkçe karakterler (ç,ş,ü,ö,ğ,Ç,Ü,Ş,Ğ,Ö,İ) .
-
~, ^^, &, <, >, €, £, ã, Ã, ‰, €, ©, ®, ∞, ° simgeleri
-
LineFeed, Enter, Tab komutları
kesinlikle kullanılmamalıdır.
Mesaj metni içerisinde sadece ( ), [ ], { }, =, *, ?, \, /, %, +, #, !, ”, :, ;, _, | simgeleri kullanılabilir.
GSM Numarası Formatına İlişkin Uyarılar
GSM numaraları 05321234567, 5321234567, 905321234567 şeklinde ve Numbers parametre düğümü içerisinde yazılmalıdır.
Unutmayın: +905321234567, 532 123 45 67, +05321234567 şeklinde ve -, ( ), [ ], { } vb. karakterlerle gönderim yapılamaz! |
Standart Dil Çevrimine İlişkin Uyarılar
Mesaj metni oluşumunda ASCII (Bilgi Değişimi İçin Amerikan Standart Kodlama Sistemi) karakterleri dışında karakter kullanımı varsa Dil Çevirici kullanılması gerekmektedir.
Çevirici Kod Örneği: $y= ("I"=>"like","she"=>"likes");
array_walk($y , create_function('&$v,$k', '$v = $k."=".$v ;'));
"index.php?".htmlentities(urlencode(implode("&",$y)), ENT_QUOTES);
?>
Unutmayın: Daha fazla Çevirici Kod Örneğine İnternet üzerinden ulaşabilirsiniz. |
Gönderen Bilgisi (Alfanumerik/Originator) Kullanımına İlişkin Uyarılar
Gönderen Bilgisi (Alfanumerik/Originator), mesaj gönderimlerinde gönderici kısmında yer alan; firmaya özel tanımlanmış 11 karakterden oluşan gönderici adıdır. Gönderim sırasında hesap aktivasyonunda aktivasyon biriminin tanımladığı Gönderen Bilgisi'nin aynısı Originator Parametre düğümü içerisinde yazılmalıdır. Gönderen Bilgisi tanımlı bilgiyle eşleşmezse 06 Hata Kodu alınır. Hata Kodu 06, Tanımsız Originator bilgisi anlamına gelir.
Unutmayın: Originator ifadesinde Türkçe karakterler ve &, <, >, -, ( ), [ ], / gibi simgeler kesinlikle kullanılmamalıdır! |
Hata Kodları
Hata Kodu | Açıklama |
01 | Hatalı Kullanıcı Adı
Hatalı Şifre
Hatalı Bayi Kodu |
02 | Yetersiz kredi (Mesaj gönderimi), Böyle bir mesaj kodu (ID) yok, Paket işlenmemiş ya da Gateway tarafında beklemede (Raporlama) |
04 | Eksik parametre girişi |
05 | Hatalı parametre girişi |
06 | Tanımsız Originator bilgisi |
Mesaj Gönderme
Gateway’a aşağıdaki parametreleri gönderirseniz Gateway’dan geri dönüş değeri olarak mesaj gönderim paketine ait mesaj kodu (TimerID) döner:
Username: Mobildev’de tanımı kullanıcı adınız
Company: Bağlı bulunduğunuz kanal bilgisi
Password: Kullanıcı hesabınızla beraber tanımlanmış şifreniz
Action: HTTP/HTTPS API’nin hangi işlev için kullanıldığını belirten parametre değeri (SMS gönderimi için bu değer “0” olmalıdır.)
Message: Göndereceğiniz mesaj metni. (Türkçe ve özel karakterler kullanılmadan, en fazla 160 karakter)
Numbers: Mesaj gönderilecek GSM numaraları
Originator: Mesajın gönderildiği GSM numarasında, gönderen kısmında çıkacak bilgi. Boş bırakılırsa kullanıcı adınıza tanımlanmış olan ilk (default) originator bilgisi kullanılır.
SDate: İleri tarihe gönderim için başlangıç tarihi. Boş bırakılırsa mesaj gönderim işlemi hemen başlar.
TimerID: Gönderilen SMS paketine, sistem tarafından otomatik olarak atanan numara
Aşağıdaki örnekte SMS gönderimi için gerekli URL ifadesi gösterilmektedir.
Örnek: SMS gönderimi için gerekli URL ifadesi
HTTP için:
http://gateway.mobilus.net/gateway.asp?username=test&company=mb1000&password=1234&action=0&message=yeni yiliniz kutlu olsun&numbers=5327654321,5427654321,55576543212
HTTPS için:
https://secure.mobilus.net/sms/gateway.asp?username=test&company=mb1000&password=1234&action=0&message=yeni yiliniz kutlu olsun&numbers=5327654321,5427654321,55576543212
Unutmayın: HTTP/HTTPS SMS gönderimi için Action değeri 0 olmalıdır! |
SMS gönderimine ait URL’yi belirtildiği gibi çağırdığınızda Gateway’dan aşağıdaki geri dönüş değerlerini alırsınız:
- İşlem başarılıysa:
ID: 1234567 şeklinde mesaj paketine ait mesaj kodu (TimerID) döner - Hata oluşmuşsa: Bknz. Hata Kodları
Raporlama
Yaptığınız SMS gönderiminin raporuna ulaşmak için username, company, password, action ve msgid parametrelerinin Gateway'e gönderilmesi gerekmektedir.
Unutmayın: Yaptığınız SMS gönderiminin raporuna ulaşmak için Gateway'den SMS paketiniz için dönen TimerID bilgisini, msgid parametresinde belirtmeniz gerekir! |
Username: Mobildev’de tanımı kullanıcı adınız
Company: Bağlı bulunduğunuz kanal bilgisi
Password: Kullanıcı hesabınızla beraber tanımlanmış şifreniz
Action: HTTP/HTTPS API’nin hangi işlev için kullanıldığını belirten parametre değeri (Raporlama için bu değer “1” olmalıdır.)
msgid: Mesaj gönderim paketine ait mesaj kodu (TimerID)
Aşağıdaki örnekte raporlama için gerekli URL ifadesi gösterilmektedir.
Örnek: SMS gönderimi için gerekli URL ifadesi
Kullanıcı bilgileri ve msgID kontrolüne ait URL’yi belirtildiği gibi çağırdığınızda Gateway’den aşağıdaki geri dönüş değerlerini alırsınız:
- İşlem başarılıysa:
TimerID<32>GSM Numarası<32>Durum<13>
şeklindedir.
Örnek: Raporlama geri dönüş değeri
1234567<32>905358838799<32>2<13>
1234567<32>905428838799<32>3<13>
1234567<32>905558838799<32>1<13>
- Hata oluşmuşsa: Bknz. Hata Kodları
Unutmayın: Durum bilgisinde: “1” mesajın beklemede olduğunu, “2” gönderildiğini, “3” ise iletilmediğini belirtir. Geri dönüş değerlerinin tümünde bulunan <32> boşluk karakterini, <13> ENTER karakterini temsil etmektedir. |
HTTP/HTTPS Api Örnek Kodlar