Kısaca: SMS API, yazılımınızın bir olay gerçekleştiğinde otomatik SMS göndermesini sağlar. Entegrasyon; API bilgilerini almak, istek göndermek, iletim raporunu sorgulamak ve hataları yönetmekten oluşur.
Bir müşteri sipariş verdiğinde onay mesajı, bir öğrenci derse gelmediğinde veliye bildirim, bir hasta randevu aldığında hatırlatma... Bu mesajların her birini panelden elle göndermek mümkün ama verimli değil. SMS API, bu mesajların yazılımınız tarafından otomatik gönderilmesini sağlar.
SMS API nedir?
API (Uygulama Programlama Arayüzü), iki yazılımın birbiriyle konuşmasını sağlayan kapıdır. SMS API sayesinde kendi yazılımınız, Nirvana SMS altyapısına "şu numaraya şu mesajı şu başlıkla gönder" talimatını verir ve sonucu geri alır.
En sık kullanım senaryoları
- E-ticaret: Sipariş onayı, kargoya verildi bildirimi, teslimat bilgisi
- Doğrulama: Üyelik ya da giriş için tek kullanımlık kod
- Okullar: Devamsızlık ve not bildirimi
- Sağlık: Randevu onayı ve hatırlatması
- Finans ve aidat: Ödeme hatırlatması, tahsilat bilgisi
- CRM: Müşteri durumu değiştiğinde otomatik bilgilendirme
Entegrasyon adımları
1. Hesap ve API bilgileri
Panelden hesabınızı açın ve onaylı bir başlığınız olduğundan emin olun. API erişimi için kullanıcı adınız ve panelden alacağınız API anahtarı kullanılır.
2. Kütüphane ya da doğrudan HTTP
Nirvana SMS API'si HTTP üzerinden XML ile çalışır. İki yolunuz var:
- Hazır kütüphane: .NET projeleri için NuGet paketi, diğer diller için GitHub'daki örnekler.
- Doğrudan istek: HTTP POST ile XML gövdesi gönderebilen her dil (PHP, Python, Java, Node.js vb.) API'yi kullanabilir.
3. İlk gönderim
İstekte başlık, alıcı numara(lar) ve mesaj metnini belirtirsiniz. Başarılı istekte size bir gönderim kimliği döner. Bu kimliği kaydedin; rapor sorgularken kullanacaksınız.
4. İletim raporu
Mesajın operatöre ulaşması ve teslim raporunun oluşması kısa bir süre alır. Gönderimden birkaç dakika sonra gönderim kimliğiyle rapor sorgulayarak her numaranın durumunu (teslim edildi, iletilemedi, beklemede) alabilirsiniz.
5. Hata yönetimi
API, hatalı isteklerde açıklayıcı bir hata kodu döner: yetersiz kredi, tanımsız başlık, hatalı numara biçimi gibi. Yazılımınızda bu kodları yakalayıp kullanıcıya anlamlı bir uyarı gösterin, gerekiyorsa yeniden deneme mantığı kurun.
Güvenlik ve iyi uygulamalar
- Anahtarı gizli tutun: API anahtarını yalnızca sunucu tarafında, ortam değişkeni ya da şifreli ayar olarak saklayın. Web sayfasına ya da mobil uygulama koduna asla yazmayın.
- Mükerrer gönderimi önleyin: Aynı mesajın kısa süre içinde tekrar gönderilmesi altyapı tarafından engellenir; yine de kendi tarafınızda da kontrol koyun.
- Numara biçimini standartlaştırın: Numaraları ülke koduyla birlikte tek bir biçimde (ör. 905xxxxxxxxx) saklayın.
- Kampanya mesajlarında kurallara uyun: API ile gönderilen ticari iletiler de İYS kurallarına tabidir.
- Krediyi izleyin: Kredi sorgulama ile bakiyeyi düzenli kontrol edin, belirli bir seviyenin altına düşünce uyarı alın.
Entegrasyonda takıldığınız bir nokta olursa teknik ekibimize ulaşın. API özelliklerinin özeti için SMS API sayfasına bakabilirsiniz.
Sık sorulanlar
SMS API kullanmak için yazılımcı olmak gerekir mi?
Kendi yazılımınıza entegrasyon için temel düzeyde yazılım bilgisi gerekir. Hazır kütüphaneler işi kolaylaştırır. Kullandığınız hazır bir programda SMS modülü varsa çoğu zaman yalnızca API bilgilerinizi girmeniz yeterlidir.
API anahtarım web şifremle aynı mı?
Hayır. API anahtarı panelden ayrıca alınır ve web paneli şifrenizden farklıdır. Bu anahtarı yalnızca sunucu tarafında saklayın, tarayıcıya ya da mobil uygulama koduna gömmeyin.
