API Servisi Kullanım Rehberi
Bu makalede, uygulamanız üzerinden API hizmeti sunmanıza olanak tanıyan bir API servisini kullanma adımlarını detaylandıracağız. Bu servis sayesinde müşterileriniz, API'ınızı kendi yazılımlarına entegre ederek hizmetlerinizi kullanabilirler.
API Kullanımı İçin Gereklilikler
- API Erişim Bilgileri: User Token ve API URL gereklidir.
- Hesap Bakiyesi: API'ı kullanarak SMS g kullanarak SMS g\u00fnderimi yapabilmek için müşteri hesabında yeterli kredi bulunmalıdır.
API ile Yapılabilecek İşlemler
- Tekil veya toplu SMS gönderimi.
- Detaylı SMS raporlarını görüntüleme.
- Güncel hesap bakiyesini sorgulama.
- SMS üret tarifesini görüntüleme.
API Erişim Bilgilerinin Edinilmesi
API URL Bilgisi
- Müşteri paneline giriş yapın.
- "Uluslararası SMS Servisi" menü seçeneğine tıklayın.
- "API Bilgileri" bölümünde API URL bilginizi bulun.
User Token Bilgisi
- Aynı şekilde müşteri paneline giriş yapın.
- "Uluslararası SMS Servisi" menü seçeneğine tıklayın.
- "API Bilgileri" bölümünde User Token bilginizi bulun.
API Kullanım Detayları
API'ye yapılan tüm istekler POST yöntemiyle gönderilmeli ve veri formatı JSON olmalıdır.
1. Tekil veya Toplu SMS Gönderimi
URL: /submit
| Parametre | Zorunlu | Açıklama |
|---|---|---|
| user_token | Evet | User Token bilgisi |
| origin | Hayır | Gönderici başlığı veya numarası (isteğe bağlı) |
| message | Evet | SMS içeriği |
| numbers | Evet | Telefon numaraları (uluslararası formatta ve dizi şeklinde) |
Örnek JSON İstek
{
"user_token": "",
"origin": "+12025550160",
"message": "Mesaj içeriği burada...",
"numbers": [
"+447517663928",
"+12126712234"
]
}
Başarılı Yanıt Örneği
{
"status": "successful",
"report_id": 12345
}
2. Detaylı SMS Raporu Görüntüleme
URL: /report
| Parametre | Zorunlu | Açıklama |
|---|---|---|
| user_token | Evet | User Token bilgisi |
| report_id | Evet | Daha önce alınan rapor ID bilgisi |
Örnek JSON İstek
{
"user_token": "",
"report_id": 12345
}
Başarılı Yanıt Örneği
{
"waiting": {
"data": [],
"count": 0
},
"conducted": {
"data": [
"+447517663928",
"+12126712234"
],
"count": 2
},
"erroneous": {
"data": [],
"count": 0
},
"status": "successful"
}
3. Güncel Bakiye Bilgisi Görüntüleme
URL: /balance
| Parametre | Zorunlu | Açıklama |
|---|---|---|
| user_token | Evet | User Token bilgisi |
Örnek JSON İstek
{
"user_token": ""
}
Başarılı Yanıt Örneği
{
"status": "successful",
"formatted": "49.643,13",
"formatted_symbolic": "$49,643.13",
"unformatted": "49643.1318",
"currency": "USD"
}
4. SMS Ücret Tarifesi Görüntüleme
URL: /prices
| Parametre | Zorunlu | Açıklama |
|---|---|---|
| user_token | Evet | User Token bilgisi |
Örnek JSON İstek
{
"user_token": ""
}
Başarılı Yanıt Örneği
{
"status": "successful",
"prices": [
{
"countryCode": "AD",
"prices": {
"USD": 0.1915,
"EUR": 0.1772,
"GBP": 0.1581,
"NGN": 73.97,
"PKR": 30.44,
"TRY": 1.3166
}
}
]
}