Kimlik Doğrulama

Mobil Uygulama Entegrasyon Kılavuzu

API, Bearer token kimlik doğrulaması kullanır. İki tür API anahtarı vardır: Kullanıcı API Anahtarı (Android cihaz gerektirmez) ve Cihaz Bazlı Token (kayıtlı bir Android telefona bağlıdır).

Token Türleri

Ücretsiz SMS pazarlama entegrasyonunuza uygun token türünü seçin:

Kullanıcı API Anahtarı - doğrudan API erişimi için (telefon gerekmez)

Cihaz gerektirmez

Entegrasyonun en basit yolu. Web panelinin Ayarlar sayfasından kişisel bir API anahtarı oluşturun ve herhangi bir HTTP istemcisi ile SMS, WhatsApp mesajlarını ve kampanyaları kuyruğa almak için kullanın. Mesajlar bağlı SMS sağlayıcıları veya krediler üzerinden gönderildiğinde Android cihaz ya da SIM kart gerekmez.

Web paneline giriş yapın ve Ayarlar sayfasına gidin.
API Anahtarı bölümüne inin ve Anahtar Oluştur düğmesine tıklayın.
Anahtarı kopyalayın ve isteklerinizin Authorization: Bearer başlığında kullanın.

Anahtarınızı istediğiniz zaman Ayarlar > API Anahtarı bölümünden yeniden oluşturabilirsiniz. Eski anahtar anında geçersiz kılınır; bu nedenle yeniden oluşturmadan önce tüm entegrasyonlarınızı güncelleyin.

Cihaz Bazlı Token - Android uygulaması için

Android cihaz gereklidir

Cihazlar bölümünde kayıtlı her Android telefon kendi token'ını alır. Bu token, Android uygulaması tarafından mesaj kuyruğunu yoklamak, teslimat durumunu bildirmek ve gelen kutusunu senkronize etmek için kullanılır. Belirli bir cihaza ve SIM karta bağlıdır.

Web panelinde Cihazlar > Cihaz Ekle bölümüne gidin.
QR kodu Android uygulamasıyla tarayın. Uygulama claim_device çağrısını yapar ve token otomatik olarak saklanır.
Uygulama, sonraki tüm istekler için Authorization: Bearer {token} kullanır.

Token Gönderimi

Authorization başlığı (tercih edilen)

HTTP

Authorization: Bearer YOUR-API-KEY

X-API-Token başlığı

HTTP

X-API-Token: YOUR-API-KEY

?token= sorgu parametresi (yedek yöntem; başlıkların proxy'ler tarafından kaldırıldığı durumlarda kullanışlıdır)

URL

https://api.rcszilla.com/?endpoint=queue_sms&token=YOUR-API-KEY

Token'lar büyük harfle saklanır ve karşılaştırılır. API, token'ınızı otomatik olarak normalleştirir.

Eski Token

Eski sürümler, ayarlarda saklanan ve kullanıcı başına tek olan paylaşımlı bir mobile_app_token kullanıyordu. Bu, geriye dönük uyumluluk için hâlâ çalışır; ancak Kullanıcı API Anahtarı veya cihaz bazlı token'lar kesinlikle tercih edilmelidir.

Geçiş notu: Uygulamanız çoklu cihaz desteği eklenmeden önce oluşturulduysa eski tekil token'ı kullanıyor olabilir. Geçiş yapmak için web panelinde Cihazlar sayfasını açın, cihaz bazlı bir token oluşturun ve uygulama yapılandırmasını güncelleyin.

Cihaz Token'ının Yaşam Döngüsü

Yönetici, web panelinde Cihazlar > Cihaz Ekle bölümünü açar ve tek kullanımlık bir kayıt token'ı (QR kodu) oluşturulur.
Uygulama QR kodu tarar ve bu token ile claim_device çağrısını yapar.
Sunucu cihaz kaydını oluşturur. Aynı token artık kalıcı cihaz bazlı API token'ı hâline gelir.
Uygulama token'ı güvenli bir şekilde saklar (Android EncryptedSharedPreferences önerilir).
Sonraki tüm istekler Authorization: Bearer {token} kullanır.
Yönetici, token'ı istediği zaman Cihazlar sayfasından yeniden oluşturabilir. Eski token anında geçersiz kılınır.