API Dökümantasyonu

Kayadelen İletişim gelişmiş mesajlaşma altyapısına hoş geldiniz.

Bu dökümantasyon, Kayadelen İletişim API servislerini projelerinize nasıl entegre edebileceğinizi gösterir. RESTful mimarisi üzerine kurulu servislerimiz standart HTTP yanıt kodlarını kullanır ve JSON formatında veri alışverişi yapar.

Base URL: Tüm istekler https://api.kayadeleniletisim.com.tr/v1 adresine yapılmalıdır.

Kimlik Doğrulama

API güvenliği için tüm isteklerde Header (Başlık) kısmında API anahtarınızı göndermeniz gerekmektedir.

Header Example 
{
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
}

Hata Kodları

API isteklerinizde dönebilecek standart HTTP yanıt kodları ve anlamları aşağıdadır.

Kod Durum Açıklama
200 OK İstek başarıyla işlendi.
400 Bad Request Hatalı parametre veya eksik veri.
401 Unauthorized API anahtarı geçersiz veya eksik.

SMS Gönder (Tekil)

Belirtilen tek bir GSM numarasına mesaj göndermek için kullanılır.

POST /sms/send
Parametreler
Parametre Tip Zorunlu Açıklama
baslik string Onaylı SMS başlığınız.
telefon string 905xxxxxxxxx formatında numara.
mesaj string Gönderilecek metin.
JSON Request 
{
  "baslik": "KAYADELEN",
  "telefon": "905551234567",
  "mesaj": "Merhaba, test mesajıdır."
}

Toplu SMS Gönder

Birden fazla numaraya aynı anda mesaj göndermek için kullanılır.

POST /sms/bulk
JSON Request 
{
  "baslik": "KAYADELEN",
  "telefonlar": ["905551234567", "905321234567"],
  "mesaj": "Toplu kampanya mesajıdır."
}

OTP Gönderimi

Hızlı ve öncelikli tek kullanımlık şifre gönderimi.

POST /sms/otp
JSON Request 
{
  "kod": "123456",
  "telefon": "905551234567"
}

Gönderim Raporları

Geçmiş gönderimlerin durumunu sorgulamak için kullanılır.

GET /reports/delivery
Query Parameters 
?start_date=2024-01-01&end_date=2024-01-31

Bakiye Sorgulama

GET /credit/balance

Hesabınızdaki güncel kredi veya TL bakiyesini öğrenmek için kullanılır.

JSON Response 
{
  "status": true,
  "credit": 1500,
  "currency": "SMS"
}