Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://api-docs.iklim.co/llms.txt

Use this file to discover all available pages before exploring further.

​
1. API Dili Seçimi

🌐 Giriş gerektirmeyen API uç noktalarında Accept-Language başlığını kullanarak yanıtların çevirisini seçebilirsiniz. Favori dilinizi otomasyonlarınıza takın ve aşağıdaki seçeneklerden birini belirtin. 🎯 
Accept-Language: tr
Accept-Language: en

​
Giriş gerektirmeyen API uç noktaları 🔓

  • Yetkilendirme Servisi ⚙️
    • Yeni Kullanıcı Kaydı - /v1/auth/register
    • Giriş İşlemi - /v1/auth/login
    • Erişim Belirteci Yenileme - /v1/auth/refresh
  • Kullanıcı Servisi 👥
    • Şifre Sıfırlama İsteği /v1/users/password-reset-request

​
Kullanıcı Dil Seçimi

Kullanıcı giriş yaptıktan sonra gönderilen Erişim Belirteci içindeki dil ve yerel ayar bilgisi otomatik olarak okunur, böylece yanıtlar doğru dile çevrilir. Ayrıca /v1/users/update uç noktasındaki Kullanıcı Güncelleme İşlemi ile kullanıcı (ADMIN ise diğer kullanıcılar için de) dil, yerel ve zaman dilimi ayarlarını rahatça güncelleyebilir. 🛠️🌎

​
2. Kullanıcı Kaydı ve Hesap Aktivasyonu

Kayıt akışındaki her adım bir öncekine bağlıdır ve sırasıyla tamamlanmalıdır. Mevcut adım başarıyla tamamlanmadan bir sonrakine geçilmemelidir. 1. adımda dönen userId ve 2. adımda dönen accountId sonraki tüm adımlarda gereklidir — her ikisini de saklayın.
1

Yeni Kullanıcı Kaydı

  • Yeni Kullanıcı Kaydı - /v1/auth/register API uç noktası üzerinden aşağıdaki bilgiler girilerek yeni bir kullanıcı kaydı oluşturulur:
    1. Kullanıcı adı (e-posta adresi)
    2. Şifre
    3. Adı
    4. Varsa Göbek Adı
    5. Soyadı
    6. Dil ve Yerel Ayarlar Tercihi
    7. Zaman Dilimi Tercihi
  • Kayıt sırasında aynı kullanıcı adına (e-posta) sahip bir kayıt varsa, 400 - Hatalı İstek kodu ve Kullanıcı Mevcut mesajı döner. 🚫
  • İşlem başarılıysa kullanıcı durumu INACTIVE olarak oluşturulur ve aktivasyon beklenir. ⏳
2

Hesap Aktivasyon İsteği

  • Hesap Aktivasyon İsteği - /v1/accounts/account-activation-request API uç noktasına aşağıdaki bilgiler gönderilerek bir hesap aktivasyon talebi oluşturulur:
    1. Kullanıcı ID
    2. Hesap Tipi
    3. Mobil Telefon Numarası (isteğe bağlı) — kabul edilen formatlar: 905xxxxxxxxx, +905xxxxxxxxx veya 5xxxxxxxxx. Tüm hesaplar genelinde benzersiz olmalıdır; numara başka bir hesaba kayıtlıysa API 400 - Hatalı İstek hatası döner. 🚫
    4. Konum Adresi (isteğe bağlı)
    5. Firma (isteğe bağlı)
    6. Endüstri (isteğe bağlı)
    7. Hesap Aktivasyon Sayfası Linki — geçici olarak herhangi bir URL girilebilir (örn. https://uygulamaniz.com/activate-account). Sistem bu linke otomatik olarak üç sorgu parametresi ekler: ?u={userId}&a={accountId}&t={token}. Oluşan tam URL, kullanıcıya gönderilen aktivasyon e-postasına yerleştirilir. 📧
  • Uç nokta; kullanıcının mevcut hesabı olup olmadığını doğrular, geçerliyse hesabı oluşturur ve aktivasyon bağlantısını içeren bir e-postayı kullanıcıya gönderir. ✉️
  • Yanıtta dönen accountId (UUID) değerini saklayın; sonraki tüm adımlarda (Hesap Aktivasyonu, Telefon Doğrulama ve Abonelik Seçimi) bu değer gereklidir. 🔑
3

Hesap Aktivasyonu

  • Hesap Aktivasyonu - /v1/accounts/activate-account API uç noktası üzerinden aşağıdaki bilgiler girilerek yeni bir hesap kaydı neticelendirilir:
    1. Kullanıcı ID
    2. Hesap ID
    3. E-posta Doğrulama Belirteci
  • Sağlanan e-posta doğrulama belirtecini kontrol ederek kullanıcı hesabını etkinleştirir, hesap ve kullanıcı durumlarını günceller ve belirtecin süresinin dolmadığını doğrular. 🔐
  • Doğrulandıktan sonra, hesap e-postası doğrulandı olarak işaretlenir ve belirteç alanları temizlenir. ✅
4

Mobil Telefon Numarası Doğrulama İsteği

  • Telefon Numarası Aktivasyon Talebi - /v1/accounts/phone-number-activation-request API uç noktası üzerinden aşağıdaki bilgiler girilerek telefon numarası doğrulama isteği yapılır:
    1. Kullanıcı ID
    2. Hesap ID
    3. Telefon Numarası Aktivasyon Sayfası Linki
  • Bir kullanıcının telefon numarası için aktivasyon sürecini yönetir. Bu, hesabın doğrulanmasını, bir telefon numarası doğrulama belirteci oluşturulmasını, bir aktivasyon mesajı oluşturulmasını ve aktivasyon SMS’inin gönderilmesini içerir. 📲
  • İsteğe bağlıdır; bu adım atlanırsa SMS bildirimleri gönderilemez. 📵
5

Mobil Telefon Numarası Doğrulaması

  • Telefon Numarası Aktivasyonu - /v1/accounts/activate-phone-number API uç noktası üzerinden aşağıdaki bilgiler girilerek telefon numarası doğrulama işlemi tamamlanır:
    1. Kullanıcı ID
    2. Hesap ID
    3. Telefon Numarası Doğrulama Belirteci
  • Uç nokta, hesapla ilişkili doğrulama belirtecini kontrol ederek telefon numarasını etkinleştirir. 🔁
6

Abonelik Seçimi

Kullanıcı abonelik seçmeden ücretli servisleri kullanamaz; bu nedenle bir sonraki adımı hızlıca tamamlayın. 💡
  • ⚠️ Ödeme yöntemi entegrasyonu tamamlanana kadar kullanıcılar yalnızca Deneme planını seçebilir. Ücretli planlar (Giriş Seviyesi, Premium, Özel) ödeme entegrasyonu tamamlandıktan sonra seçilebilir hale gelecektir.

​
3. Abonelik İşlemleri

  • Abonelik Güncelleme - /v1/accounts/update-subscription API uç noktası üzerinden aşağıdaki bilgiler girilerek kullanıcı için abonelik güncellemesi yapılır:
    • Plan Seçimi
      1. Kullanıcı ID
      2. Abone ID
      3. Abonelik Planı İsmi
    • Özel Plan Oluşturma
      1. Kullanıcı ID
      2. Abone ID
      3. Plan Detayları
        1. Abonelik Süresi
        2. Limit Sıfırlama Periyodu
        3. Coğrafi Sınır
        4. API Servis Limitleri
          1. API Versiyonu
          2. API Endpoint İsmi
          3. Maksimum Çağrı Sayısı
  • Bu uç nokta gerekli rol ve hesap kontrollerini yapar, abonelik planını günceller, gerekiyorsa kullanıcı durumunu değiştirir ve doğrulama hatası varsa anlaşılır mesajlar döndürür. ✅📬

​
3.1. Abonelik Planları 📦

PlanSüreLimit ProfiliCoğrafi KapsamKısa Not
Hiçbiri-Limit uygulanmazUygulanmazAboneliği olmayan veya iptal edilen kullanıcıların varsayılan durumu.
Deneme1 ayGünlük 5 çağrı limiti, çok düşük hacimTüm bölgelerKullanıcı başına tek seferlik deneme; değerlendirme amaçlı.
Giriş Seviyesi - Aylık1 ayAylık sıfırlama, limit sayısı 1, kısıtlı çağrı hakkıTüm bölgelerEkonomik opsiyon; her ay yenilenerek kullanılır.
Giriş Seviyesi - Yıllık1 yılYıllık kota, sınırlı toplam çağrıTüm bölgeler1 yıl boyunca esnek şekilde harcanabilen ekonomik paket.
Premium - Aylık1 ayAylık sıfırlama, yüksek allowanceTüm bölgelerÜst seviye aylık erişim; ay sonunda yenileyin.
Premium - Yıllık1 yılYıllık kota, geniş limitlerTüm bölgelerPremium yıllık paket; geniş kotayı yıl boyunca kullanın.
ÖzelTercihe göreSüre, limit tipi ve çağrı sayısı ayarlanabilirÜlke/bölge sınırları yapılandırılabilirTüm parametreleri müşteri sözleşmesine göre uyarlayabileceğiniz esnek plan.

​
3.2. Özel Abonelik Seçeneği İçin Coğrafi Sınır Seçenekleri 🗺️

  1. Tümü
  2. Akdeniz Bölgesi
  3. Doğu Anadolu Bölgesi
  4. Ege Bölgesi
  5. Güneydoğu Anadolu Bölgesi
  6. İç Anadolu Bölgesi
  7. Marmara Bölgesi
  8. Karadeniz Bölgesi