Skip to content
Akedly
V1.2 Shield SDKs

Shield SDKs

Akedly Shield SDKs handle Proof-of-Work challenge solving and Cloudflare Turnstile token retrieval for the V1.2 REST API. Each SDK manages threading automatically -- Web Workers in browsers, Isolates in Dart, async/await in Swift, and coroutines in Kotlin.

Build with AI agents
Note:

Distribution

Web and React Native ship as the @akedly/shield package on npm. The iOS, Flutter, and Android SDKs are distributed directly from GitHub: iOS via Swift Package Manager's native Git URL support, Flutter via a git: pubspec entry, and Android via JitPack or a local Gradle module. All four are at 1.1.0, the release that adds passkey support. The Flutter and Android SDKs are not published on pub.dev or Maven Central yet.

Danger:

Keep your API key on your backend

APIKey and pipelineID are credentials. Never embed them in web bundles, APKs, or iOS/Flutter binaries — they can be extracted. Each SDK page below shows the recommended two-tab pattern: a Node.js backend that proxies /auth/akedly/challenge, /auth/akedly/send, /auth/akedly/verify, and a frontend that only talks to that proxy. The Shield SDK still runs on the client so PoW and Turnstile stay tied to the real user.

Warning:

Required: the end user's IP on every send

Your backend proxy must include the x-end-user-ip header on every POST /api/v1.2/transactions/send, set to the real end user's IP — the one that hit your backend, not your server or load balancer IP — and never read on the user's device. Per-IP rate limits, Turnstile and Cluster Gate AI Protection use it. Every SDK page's Node.js backend example sets it with req.ip plus app.set('trust proxy', 1). Phone and pipeline limits always apply as well. See the V1.2 API reference for Node/Express, Next.js, Flask, and PHP extraction patterns.

V1.2 API Reference

Build with AI agents

Platform SDKs

Web / JavaScript

  • Package: @akedly/shield
  • Install: npm / CDN
  • PoW: Web Worker (auto)
  • Turnstile: getTurnstileToken()

Flutter / Dart

  • Package: akedly_shield
  • Install: GitHub (pubspec git:)
  • PoW: Isolate
  • Turnstile: AkedlyTurnstile widget

iOS / Swift

  • Package: AkedlyShield
  • Install: SPM (GitHub URL)
  • PoW: async/await
  • Turnstile: AkedlyTurnstile (WKWebView)

Android / Kotlin

  • Package: akedly-shield-kotlin
  • Install: GitHub (JitPack / local module)
  • PoW: Coroutines
  • Turnstile: AkedlyTurnstile (WebView)

React Native

  • Package: @akedly/shield
  • Install: npm
  • PoW: Batched main-thread
  • Turnstile: Bridge page

PoW Algorithm

All Shield SDKs implement the same Proof-of-Work algorithm. The solver computes SHA256(challenge + ":" + nonce) and checks whether the hex digest starts with the required number of leading zeros.

text
challenge = "a1b2c3d4e5f6..."        // 64-char hex string from server
difficulty = 4                        // number of leading hex zeros required

nonce = 0
loop:
  hash = SHA256(challenge + ":" + String(nonce))
  if hash starts with "0000":         // difficulty = 4 leading zeros
    return nonce
  nonce++

The difficulty is set per-pipeline in the Akedly dashboard. Higher difficulty increases computational cost, providing stronger bot protection at the expense of longer solve times. Adaptive difficulty mode automatically adjusts based on traffic patterns.

Note:

Performance

Typical solve times range from under 100ms (difficulty 3) to a few seconds (difficulty 5+). Shield SDKs use background threads to keep the UI responsive during solving.

Turnstile Integration

When turnstile.required is true in the challenge response, the client must obtain a Cloudflare Turnstile token before calling the Send endpoint.

Each platform handles Turnstile differently:

  • Name
    Web
    Type
    getTurnstileToken()
    Description

    Creates a hidden Turnstile widget in the DOM, resolves with the token, and cleans up automatically.

  • Name
    Flutter
    Type
    AkedlyTurnstile widget
    Description

    Flutter widget that loads a Turnstile bridge page via WebView. Add it to your widget tree and receive the token via onToken callback.

  • Name
    iOS
    Type
    AkedlyTurnstile.getToken()
    Description

    Uses a hidden WKWebView to load the Turnstile bridge page at turnstile.akedly.io. Returns the token via async/await.

  • Name
    Android
    Type
    AkedlyTurnstile.getToken()
    Description

    Creates an invisible WebView to load the Turnstile bridge page. Returns the token via coroutine.

  • Name
    React Native
    Type
    Bridge page
    Description

    Uses a WebView pointing to turnstile.akedly.io to obtain the token. See the React Native SDK page for details.

Turnstile tokens expire after 2 minutes. Generate a new token for each OTP request.

V1.2 API Reference