Flutter SDK

Плагин Flutter, построенный на нативных iOS / Android SDK, предоставляющий единый Dart-класс CaptchalaClient для обеих мобильных платформ (с поддержкой настольных Linux / macOS / Windows через встроенный WebView).

Демо на GitHub

📦

Captcha-La/flutter-demo — полный рабочий пример со всеми шагами интеграции.

Установка

Добавьте пакет с pub.dev:

# pubspec.yaml
dependencies:
  captchala: ^1.3.2
  http: ^1.2.0          # used by the demo's token-fetch helpers

flutter pub get
flutter run               # auto-picks the foreground device
# or:
flutter run -d <device-id>

Для iOS / macOS первая сборка автоматически выполнит pod install. Убедитесь, что ios/Podfile объявляет platform :ios, '13.0' (или выше).

Быстрый старт

import 'package:flutter/material.dart';
import 'package:captchala/captchala.dart';

class LoginScreen extends StatefulWidget {
  const LoginScreen({super.key});
  @override
  State<LoginScreen> createState() => _LoginScreenState();
}

class _LoginScreenState extends State<LoginScreen> {
  String _status = 'Tap to verify';
  bool _verifying = false;

  Future<void> _runVerify() async {
    setState(() { _verifying = true; _status = 'Fetching server_token...'; });

    // 1. Fetch a one-shot server_token from YOUR backend.
    final initialToken = await fetchServerTokenFromYourBackend();

    // 2. Build config from your business action.
    final config = CaptchalaConfig(
      appKey: 'YOUR_APP_KEY',
      action: 'login',                  // login, register, pay, …
      lang: 'en',                       // en, zh-CN, zh-TW, ja, ko, ms, vi, id
      theme: 'light',                   // 'light' | 'dark'
      enableVoice: true,
      enableOfflineMode: true,
      maskClosable: false,
      serverToken: initialToken,
    );

    // 3. Initialize, register callbacks, then call verify().
    final client = await CaptchalaClient.instance.initialize(config);
    client.setCallbacks(
      onSuccess: (r) async {
        // Send r.passToken to YOUR backend for validation.
        if (!mounted) return;
        setState(() { _status = 'OK: ${r.passToken}'; _verifying = false; });
      },
      onFail:    (e) { if (mounted) setState(() { _status = 'fail: ${e.code}'; _verifying = false; }); },
      onError:   (e) { if (mounted) setState(() { _status = 'error: ${e.code} ${e.message}'; _verifying = false; }); },
      onClose:   () { if (mounted && _verifying) setState(() { _status = 'closed'; _verifying = false; }); },
      onServerTokenExpired: () => fetchServerTokenFromYourBackend(),
    );
    await client.verify();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(mainAxisSize: MainAxisSize.min, children: [
          ElevatedButton(
            onPressed: _verifying ? null : _runVerify,
            child: Text(_verifying ? 'Verifying...' : 'Verify with CAPTCHA'),
          ),
          const SizedBox(height: 12),
          Text(_status, style: const TextStyle(fontFamily: 'monospace')),
        ]),
      ),
    );
  }
}

Поверхность API

Символ	Назначение
CaptchalaClient.instance	Singleton-доступ к плагину.
CaptchalaConfig(...)	Простой Dart-record: appKey, action, lang, theme, enableVoice, enableOfflineMode, maskClosable, serverToken.
await client.initialize(config)	Применяет конфигурацию. Возвращает тот же экземпляр клиента, чтобы сцепить setCallbacks.
setCallbacks(...)	Регистрирует callback-и onSuccess, onFail, onError, onClose, onServerTokenExpired.
await client.verify()	Открывает нативное представление CAPTCHA (Android: Activity поверх Flutter; iOS: UIViewController поверх Flutter).
CaptchalaResult	Передаётся в onSuccess. Поля: passToken, challengeId, ttl, isOffline, isClientOnly.

Серверная проверка

Перешлите result.passToken (или result.token) на ваш backend и проверьте его через API CaptchaLa. Никогда не размещайте X-App-Secret в клиентском коде.

POST https://apiv1.captcha.la/v1/validate
X-App-Key: YOUR_APP_KEY
X-App-Secret: YOUR_APP_SECRET
Content-Type: application/json

{ "pass_token": "<result.passToken>", "client_ip": "<end-user IP>" }

См. Справочник API для полного endpoint проверки и потока X-App-Key / X-App-Secret.

Устранение неполадок

• iOS pod install не работает
  В ios/Podfile задайте platform :ios, '13.0' (или выше). После смены версии плагина выполните flutter clean && flutter pub get && cd ios && pod install.

• Несоответствие minSdkVersion на Android
  Поднимите android/app/build.gradle до minSdkVersion 21. Нативный Android SDK откажется компилироваться ниже этого значения.

• Callback-и срабатывают на фоновом изоляте
  Всегда защищайте setState проверкой if (mounted) перед изменением состояния UI внутри callback-ов. Демо оборачивает каждый callback, обновляющий состояние, такой проверкой.

• Настольные платформы (Linux / Windows / macOS)
  Linux требует GTK3 + WebKitGTK + libcurl. Windows нужен Edge WebView2 Runtime (Win 10 1809+). На настольном macOS автоматически используется системный WebView.

Требования

• Flutter 3.10+ / Dart 3.0+
• Android: minSdkVersion 21 (Android 5.0+)
• iOS: 13.0+ с CocoaPods
• Desktop (опционально): GTK3 + WebKitGTK на Linux, WebView2 Runtime на Windows 10 1809+