Pzt - Paz / 09:00 - 18:30

Api Dökümantasyonu


SMS API Nedir ?

API'nin açılımı Application Programming Interface olarak bilinir. Programların özelliklerine göre A programının B programına entegrasyonunun sağlaması için oluşturulan uygulama kodu olarak bilinir. Bu kısım yazılım bilgisi gerektirdiğinden İlk SMS kullanıcılarının kullandıkları programın SMS bildirimi özelliği var ise yazılımın sağlayıcısından nasıl entegrasyon sağlayacağının desteği almalıdır. İlk SMS sizlere programınızda kullanabileceğiniz API kodlarını sunmaktadır.


Bu kodların uygulanması ve entegrasyonu işlemi ise yazılımı sağlayan kuruluşa aittir. API kodları ile bir çok yazılım ve donanıma entegrasyon mümkündür. Eğitim merkezlerinin sınav sonuçlarını hazırladığı programlar, okulların turnike sistemleri ve daha bir çok SMS bildirim desteği olan yazılıma API ile entegrasyon yapılır.


İlk SMS'e ait API kodlarını nerede kullanabilirim?

Günlük hayatımızda bildirimleri en çok SMS olarak aldığımız için bir çok program da SMS bildirim özelliğine sahiptir. Kullanmakta olduğunuz okul yazılımları arasında Sınav Sonuçları, Kartlı, Turnikeli Giriş Sistemleri, Okul Güvenlik Sistemleri ve Okulların kendi hazırladıkları programlarda kullanabileceğiniz İlk SMS API kodları sayesinde manuel olarak yapmak istediğiniz işlemleri otomatik olarak yaparsınız.


Ülkemiz Türkiye de modern teknoloji en çok eğitim kurumları tarafından tercih edilmektedir. Bu teknolojiler belirli özellikleri içerisinde barındırır iken yazılımlar kullanarak işletilmektedir. Bu yazılımların SMS bildirim özelliği olan tümüne İlk SMS API kodlarının entegrasyonu mümkündür. Robot teknolojisinin gelişmesi ile otomasyon sistemlerine entegrasyon da API kodları ile sağlanmaktadır. Okula gelmeyen her öğrenciyi takip etmekte zorluk çekmek yerine giriş turnikelerini kullanabilirsiniz. Belirli süreler içerisinde okula gelmeyen öğrenci için velisine SMS bildirimini turnike sayacını sağlayan programın SMS bildirim özelliğine API kodlarımızın entegrasyonu ile bağlayarak hızlı bilgilendirmeye sahip olabilirsiniz.


Kısaca İlk SMS API kodlarını programların SMS bildirim özelliği olan ve API desteği olan tümünde kullanmanız mümkündür. Bu konuda detaylı bilgiyi önce program sağlayıcınızdan sonra ise bizden alabilirsiniz.


Okul Numaralarına SMS

API Post URL : http://app.ilksms.com/api/okulnosms
Sonuç Formatı : JSON
Gerekli Parametreler Açıklaması
apiUsername Hesabınıza tanımlı API kullanıcı adı.
apiPassword Hesabınıza tanımlı API şifresi.
baslik SMS göndermek istediğiniz hesabınıza tanımlı, onaylı gönderici adı.
mesaj Mesaj içeriği.
veliTur Varsayılan Değer : “1” Kabul Edilen Değerler “1” : 1. Veliye“2” : 2. Veliye “12” : 1. ve 2. Veliye Veli Türü ile öğrencinin 1. velisine, 2. velisine veya iki velisine birden SMS gönderebilirsiniz.
tur Varsayılan Değer : “normal” Kabul Edilen Değerler “normal” : Default tipte SMS gönderimi 160 karakter. “turkce” : Türkçe karakterli SMS gönderimi 155 karakter.
okulNumaralari Örnek Değer : “17,245,602” Birden fazla okul numarası virgül ile ayrılarak gönderilebilir.
rehberTur Varsayılan Değer : “0”. Okul numarası ile öğrenciye ulaşırken sorgu ilk bulunan öğrenciye SMS gönderir.Eğer hesabınızda bir rehber türü ayrımı var ise bu rehber türü ayrımı ile ilk bulunan “1” numaralı öğrenciye SMS göndermek yerine belirttiğiniz rehber türüne sahip olan “1” numaralı öğrenciye SMS gönderebilirsiniz.
tarih "Bu parametre opsiyoneldir" Format : “30/01/2019” İleri tarihli/saatli SMS gönderimi için belirtilen formatta tarih değerini gönderebilirsiniz. “tarih” veya “saat” paramatrelerinden herhangi birisi gönderilmez ise gönderim hemen başlatılır.
saat Format : “17:05” İleri tarihli/saatli SMS gönderimi için SMS saat/dakika bilgisini bu parametre ile iletebilirsiniz. “tarih” veya “saat” paramatrelerinden herhangi birisi gönderilmez ise gönderim hemen başlatılır.

Hesap Bilgisi

API Post URL : http://app.ilksms.com/api/kullanicibilgi
Sonuç Formatı : JSON
Gerekli Parametreler Açıklaması
apiUsername Hesabınıza tanımlı API kullanıcı adı.
apiPassword Hesabınıza tanımlı API şifresi.

N to N SMS

API Post URL : http://app.ilksms.com/api/ntonsms
Sonuç Formatı : JSON
Gerekli Parametreler Açıklaması
apiUsername Hesabınıza tanımlı API kullanıcı adı.
apiPassword Hesabınıza tanımlı API şifresi.
baslik SMS göndermek istediğiniz hesabınıza tanımlı, onaylı gönderici adı.
tur Varsayılan Değer : “normal” Kabul Edilen Değerler “normal” : Default tipte SMS gönderimi 160 karakter. “turkce” : Türkçe karakterli SMS gönderimi 155 karakter.
telMesajlar JSON'un içerisinde
[
  {
    "mesaj":"test",
    "telefon":"05xxxxxxxxx"
  },
  {
     "mesaj":"test",
     "telefon":"05xxxxxxxxx"
  }
]
bu şekilde istediğiniz kadar mesaj gönderebilirsiniz.
tarih Format : “30/01/2019” İleri tarihli/saatli SMS gönderimi için belirtilen formatta tarih değerini gönderebilirsiniz. “tarih” veya “saat” paramatrelerinden herhangi birisi gönderilmez ise gönderim hemen başlatılır.
saat Format : “17:05” İleri tarihli/saatli SMS gönderimi için SMS saat/dakika bilgisini bu parametre ile iletebilirsiniz. “tarih” veya “saat” paramatrelerinden herhangi birisi gönderilmez ise gönderim hemen başlatılır.

Grup/Sınıf Listesi

API Post URL : http://app.ilksms.com/api/gruplar
Sonuç Formatı : JSON
Gerekli Parametreler Açıklaması
apiUsername Hesabınıza tanımlı API kullanıcı adı.
apiPassword Hesabınıza tanımlı API şifresi.