---
title: Flutter-SDK
---

# Flutter-SDK

Flutter-Plugin, aufgebaut auf den nativen iOS- / Android-SDKs, das einen einzigen Dart-`CaptchalaClient` für beide Mobilplattformen bereitstellt (mit Desktop-Unterstützung für Linux / macOS / Windows über eingebetteten WebView).

## Demo auf GitHub

::: tip 📦
[Captcha-La/flutter-demo](https://github.com/Captcha-La/flutter-demo) — vollständiges lauffähiges Beispiel mit allen Integrationsschritten.
:::

## Installation

Fügen Sie das Paket von pub.dev hinzu:

```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>
```

Für iOS / macOS führt der erste Build `pod install` automatisch aus. Stellen Sie sicher, dass `ios/Podfile` `platform :ios, '13.0'` (oder höher) deklariert.

## Schnellstart

```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-Übersicht

| Symbol | Zweck |
| --- | --- |
| `CaptchalaClient.instance` | Singleton-Zugriff auf das Plugin. |
| `CaptchalaConfig(...)` | Einfacher Dart-Record: `appKey`, `action`, `lang`, `theme`, `enableVoice`, `enableOfflineMode`, `maskClosable`, `serverToken`. |
| `await client.initialize(config)` | Wendet die Konfiguration an. Liefert dieselbe Client-Instanz, sodass `setCallbacks` verkettet werden kann. |
| `setCallbacks(...)` | Registriert die Callbacks `onSuccess`, `onFail`, `onError`, `onClose`, `onServerTokenExpired`. |
| `await client.verify()` | Öffnet die native CAPTCHA-Ansicht (Android: Activity über Flutter; iOS: UIViewController über Flutter). |
| `CaptchalaResult` | Wird an `onSuccess` übergeben. Felder: `passToken`, `challengeId`, `ttl`, `isOffline`, `isClientOnly`. |

## Serverseitige Validierung

Leiten Sie `result.passToken` (oder `result.token`) an Ihr Backend weiter und validieren Sie ihn gegen die CaptchaLa-API. Geben Sie `X-App-Secret` niemals im Client-Code preis.

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

Siehe die [API-Referenz](/de/api-reference) für den vollständigen Validierungs-Endpoint und den `X-App-Key` / `X-App-Secret`-Flow.

## Fehlerbehebung

- **`pod install` unter iOS schlägt fehl**  
  Setzen Sie in `ios/Podfile` `platform :ios, '13.0'` (oder höher). Führen Sie nach einem Wechsel der Plugin-Version `flutter clean && flutter pub get && cd ios && pod install` aus.

- **Android `minSdkVersion`-Konflikt**  
  Heben Sie `android/app/build.gradle` auf `minSdkVersion 21` an. Das native Android-SDK kompiliert unterhalb dieser Version nicht.

- **Callbacks feuern auf Background-Isolate**  
  Schützen Sie `setState` stets mit `if (mounted)`, bevor Sie UI-State innerhalb von Callbacks ändern. Die Demo umhüllt jeden Callback, der State aktualisiert, mit dieser Prüfung.

- **Desktop-Targets (Linux / Windows / macOS)**  
  Linux benötigt GTK3 + WebKitGTK + libcurl. Windows benötigt die Edge WebView2 Runtime (Win 10 1809+). macOS-Desktop nutzt automatisch den System-WebView.

## Voraussetzungen

- Flutter 3.10+ / Dart 3.0+
- Android: `minSdkVersion 21` (Android 5.0+)
- iOS: 13.0+ mit CocoaPods
- Desktop (optional): GTK3 + WebKitGTK unter Linux, WebView2 Runtime unter Windows 10 1809+