Flutter SDK

ネイティブ iOS / Android SDK をラップした Flutter プラグイン。両プラットフォームで同じ Dart の CaptchalaClient を使えます。Linux / macOS / Windows のデスクトップ（埋め込み WebView）にも対応。

GitHub のデモ

📦

Captcha-La/flutter-demo — すべての統合手順を含む実行可能なサンプル。

インストール

Add the package from pub.dev:

yaml

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

bash

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

For iOS / macOS the first build runs pod install automatically. Make sure ios/Podfile declares platform :ios, '13.0' (or higher).

クイックスタート

dart

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`	プラグインのシングルトンアクセサ。
`CaptchalaConfig(...)`	単純な Dart レコード：`appKey` / `action` / `lang` / `theme` / `enableVoice` / `enableOfflineMode` / `maskClosable` / `serverToken`。
`await client.initialize(config)`	設定を適用し、同じクライアントインスタンスを返します（`setCallbacks` をチェーン可能）。
`setCallbacks(...)`	`onSuccess` / `onFail` / `onError` / `onClose` / `onServerTokenExpired` のコールバックを登録します。
`await client.verify()`	ネイティブの CAPTCHA ビューを開きます（Android: Flutter の上に Activity、iOS: UIViewController）。
`CaptchalaResult`	`onSuccess` に渡されるオブジェクト。フィールド：`passToken` / `challengeId` / `ttl` / `isOffline` / `isClientOnly`。

サーバー側検証

result.passToken（または result.token）はバックエンドに転送し、CaptchaLa API で検証します。X-App-Secret をクライアント側コードに含めないでください。

bash

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>" }

完全な検証エンドポイントと X-App-Key / X-App-Secret のフローは API リファレンスを参照してください。

トラブルシューティング

iOS の pod install が失敗する
ios/Podfile に platform :ios, '13.0' 以上を指定してください。プラグインのバージョンを変えたら flutter clean && flutter pub get && cd ios && pod install を実行します。
Android の minSdkVersion 不一致
android/app/build.gradle の minSdkVersion を 21 に引き上げてください。それ未満ではネイティブ SDK がコンパイルを拒否します。
コールバックがバックグラウンド isolate で発火する
コールバック内で UI 状態を変更する前に必ず if (mounted) でガードしてください。デモではすべての該当コールバックでこのチェックを行っています。
デスクトップターゲット（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+ with CocoaPods
Desktop (optional): GTK3 + WebKitGTK on Linux, WebView2 Runtime on Windows 10 1809+

Flutter SDK ​

GitHub のデモ ​

インストール ​

クイックスタート ​

主な API ​

サーバー側検証 ​

トラブルシューティング ​

動作環境 ​