React Native SDK
SDK 1.2.0
React Native 1.0.0, SDK 1.2.0 üzerine kuruludur. Bazı ayrıntılar yalnızca İngilizce olarak mevcuttur: İngilizce sayfaya ve değişiklik günlüğüne bakın.
@captcha-la/react-native, CaptchaLa'yı Android ve iOS üzerindeki React Native uygulamalarına ekler. Güncel sürüm: 1.0.0. Yerel SDK'ların (Android la.captcha:captchala 1.2.0 ve iOSCaptchalaSDK 1.2.0) üzerinde ince bir köprüdür: doğrulama, yükleme göstergesi ve cihaz kontrollerinin tümü yerel olarak çalışır.
GitHub'daki demo
📦
Captcha-La/react-native-demo — Android ve iOS için çalıştırılabilir örnek uygulama.
Kurulum
npm install @captcha-la/react-native
cd ios && pod installAutolinking, yerel modülü her iki platformda da ekler. Ardından uygulamayı yeniden derleyin (npx react-native run-android / run-ios); JavaScript'i yeniden yüklemek yeterli değildir. Android SDK'sı Maven Central'dan, iOS SDK'sı CocoaPods'tan gelir; ikisi de otomatik olarak eklenir.
Hızlı başlangıç
import Captchala from '@captcha-la/react-native';
Captchala.setCallbacks({
onReady: () => {}, // the challenge is on screen
onSuccess: (r) => submit(r.passToken), // send the pass token to your backend
onFail: (e) => {}, // the user did not pass (can retry)
onError: (e) => {}, // network, configuration or system error
onClose: () => {}, // closed by the user
onExpired: () => {}, // the pass token expired: ask to verify again
onServerTokenExpired: async () => fetchServerTokenFromYourBackend(),
});
await Captchala.initialize({
appKey: 'YOUR_APP_KEY',
action: 'login',
serverToken, // one-time token from your backend, if your app requires one
});
await Captchala.verify();Pass token'a güvenmeden önce onu her zaman arka ucunuzda doğrulayın (bkz. Sunucu tarafı doğrulama).
Yapılandırma
Captchala.initialize(config); yalnızca appKey zorunludur.
| Seçenek | Tür | Varsayılan | Açıklama |
|---|---|---|---|
appKey | string | — | Zorunlu. Paneldeki uygulama anahtarınız. |
action | string | "default" | İş eylemi, ör. "login", "register", "pay". |
account | string | — | İsteğe bağlı hesap tanımlayıcısı. |
lang | string | otomatik | Arayüz dili, ör. "zh-CN", "en", "ja". Ayarlanmazsa cihaz dili kullanılır. Bkz. Desteklenen diller. |
theme | 'auto' | 'light' | 'dark' | 'auto' | Varsayılan olarak sistemi izler. |
title | string | — | Doğrulamanın üzerindeki başlık. |
timeout | number (ms) | 10000 | HTTP zaman aşımı. |
retryCount, retryDelay | number | SDK varsayılanı | Ağ yeniden denemeleri. |
enableVoice | boolean | SDK varsayılanı | Sesli doğrulamayı sun. |
enableOfflineMode | boolean | false | Sunuculara ulaşılamadığında çevrimdışı yedek yol. Sonuçlar bu durumda isOffline / isClientOnly taşır. |
serverToken | string | — | Arka ucunuzdan gelen tek kullanımlık token. |
loadingStyle | 'spinner' | 'ring' | 'dots' | 'none' | 'spinner' | Doğrulama yüklenirken gösterilen gösterge. Bkz. Yükleme göstergesi. |
loadingColor | '#RRGGBB' / '#RRGGBBAA' | beyaz | Gösterge rengi. |
loadingSize | 'small' | 'medium' | 'large' | 'medium' | Gösterge boyutu. |
loadingDelay | number (ms) | 300 | Yalnızca doğrulama bu süreden uzun sürerse gösterilir (0–5000). |
Yapılandırmayı değiştirmek için, örneğin yeni bir serverToken ile, initialize() yöntemini yeniden çağırın.
API
| Yöntem | Açıklama |
|---|---|
Captchala.initialize(config) | Yerel SDK'yı yapılandırır. verify() öncesinde çağırın; yeniden çağırmak yapılandırmayı değiştirir. |
Captchala.setCallbacks(callbacks) | Geri çağrıları ayarlar (tümü isteğe bağlı). Öncekilerin yerini alır. |
Captchala.verify() | Doğrulamayı gösterir. Sonuçlar geri çağrılar üzerinden gelir. |
Captchala.dismiss() | Doğrulamayı programatik olarak kapatır. |
Geri çağrılar
| Geri çağrı | Aldığı değer | Ne zaman |
|---|---|---|
onReady | — | Doğrulama ekranda. |
onSuccess | { passToken, challengeId, isOffline, isClientOnly } | Doğrulandı. passToken değerini arka ucunuza gönderin. |
onFail | { code, message } | Kullanıcı geçemedi; yeniden deneyebilir. |
onError | { code, message } | Ağ, yapılandırma veya sistem hatası. code değerine göre dallanın; message İngilizce tanılama metnidir. |
onClose | — | Kullanıcı doğrulamayı kapattı. |
onExpired | passToken | Pass token kullanılmadan önce süresi doldu. Bkz. Token süresinin dolması. |
onServerTokenExpired | — | Sunucu token'ı reddedildi. Arka ucunuzdan yenisini döndürün (bir Promise<string>), SDK devam eder; hatayı bildirmek için null döndürün. |
Token süresinin dolması
onSuccess ile gelen pass token sınırlı bir süre geçerlidir; bu süreyi sunucu belirler. Formunuz token'ı o zamana kadar kullanmadıysa onExpired bir kez çağrılır. Böylece süresi dolmuş bir token göndermek yerine saklanan token'ı temizleyip kullanıcıdan yeniden doğrulama isteyebilirsiniz:
Captchala.setCallbacks({
onSuccess: (r) => setPassToken(r.passToken),
onExpired: () => {
setPassToken(null);
setNeedsVerify(true); // your button calls Captchala.verify() again
},
});onExpired her başarı için en fazla bir kez çağrılır; yeni bir verify() veya initialize() sonrasında çağrılmaz.
Yükleme göstergesi
Doğrulama yüklenirken yerel SDK, karartılmış arka planın üzerinde küçük bir gösterge gösterir. Gösterge yalnızca yükleme loadingDelay değerinden uzun sürerse görünür ve doğrulama gösterildiğinde kaybolur. 'spinner' (varsayılan) klasik çubuklu göstergedir, 'ring' dönen bir yaydır. 'none' ile hiçbir şey gösterilmez: verify() çağrısından onReady gelene kadar kendi göstergenizi gösterin.
await Captchala.initialize({
appKey: 'YOUR_APP_KEY',
loadingStyle: 'dots',
loadingColor: '#3B82F6',
loadingSize: 'small',
loadingDelay: 500,
});Sunucu tarafı doğrulama
passToken değerini arka ucunuza gönderin ve orada doğrulayın. X-App-Secret değerini asla uygulamaya koymayın.
POST https://verify.captcha.la/v1/validate
X-App-Key: YOUR_APP_KEY
X-App-Secret: YOUR_APP_SECRET
Content-Type: application/json
{ "pass_token": "<passToken>" }İsteğe bağlı tek kullanımlık serverToken değerini düzenlemek için arka ucunuz POST /v1/server/challenge/issue çağrısını yapar. Bkz. API Başvurusu ve sunucu token'ları; ya da PHP / Go sunucu SDK'sını kullanın.
Sorun giderme
The native module for '@captcha-la/react-native' is not linked
Paketi kurduktan sonra uygulamayı yeniden derleyin. iOS'ta önceios/içindepod installçalıştırın.iOS derlemesi
CaptchalaSDKbulamıyorios/içindepod repo updateve ardındanpod installçalıştırın. Dağıtım hedefi iOS 13 veya üzeri olmalıdır.Android
webview_too_old
Etkileşimli doğrulama Android System WebView 63+ gerektirir. Bkz. Android SDK (İngilizce).
Gereksinimler
- React Native 0.73+ (New ve Old Architecture)
- Android 5.0+ (
minSdk 21) - iOS 13+