Skip to content

Web SDK

Web SDKはすべてのモダンブラウザをサポートし、複数の統合方法を提供します。

30 秒で動作を確認

demo-v1.captcha.la — 純粋な HTML + PHP、MIT ライセンス、全ページでソース表示可能。

クイックスタート

html
<!-- 1. Load via CDN (or npm install captchala) -->
<script src="https://cdn.captcha-cdn.net/captchala-loader.js"></script>

<button id="login-btn">Sign in</button>

<script>
loadCaptchala(function () {
  Captchala.init({
    appKey: 'YOUR_APP_KEY',
    product: 'bind',
    action: 'login',
    lang: 'auto',
  })
  .onSuccess(res => sendToBackend(res.token))
  .onError(err => console.error(err.message))
  .bindTo('#login-btn');
});
</script>

インストール

CDN

html
<!-- Recommended: auto-fallback loader, ~6 KB gzip -->
<script src="https://cdn.captcha-cdn.net/captchala-loader.js"></script>

NPM

bash
npm install captchala
# or framework wrappers
npm install @captcha-la/vue
npm install @captcha-la/react
js
import Captchala from 'captchala';
import 'captchala/dist/captchala.css';

モード一覧

ポップアップモード

js
Captchala.init({ appKey: 'YOUR_APP_KEY', product: 'popup', action: 'login' })
  .bindTo('#login-btn')
  .onSuccess(res => sendToBackend(res.token));

フロートモード

js
Captchala.init({ appKey: 'YOUR_APP_KEY', product: 'float', action: 'browse' })
  .appendTo('#captcha-container')
  .onSuccess(res => sendToBackend(res.token));

バインドモード

js
Captchala.init({ appKey: 'YOUR_APP_KEY', product: 'bind', action: 'login' })
  .bindTo('#submit-button')
  .onSuccess(res => submitForm(res.token));   // fires only after challenge passes

埋め込みモード

js
Captchala.init({ appKey: 'YOUR_APP_KEY', product: 'embed', action: 'register' })
  .appendTo('#captcha-container')
  .onSuccess(res => sendToBackend(res.token));

よく使うオプション

パラメータデフォルト説明
appKeystringApp Key(必須)
productstringpopup表示モード:popup
actionstringdefaultビジネスシーン
langstringen対応言語:zh-CN / zh-TW / en / ja / ko / ms / vi / id
serverTokenstringサーバー発行のワンタイムトークン(sct_xxx)。本番環境では強く推奨
onServerTokenExpired() => Promise<string>serverToken 期限切れ時に呼ばれ、新しいトークンを返して SDK が検証を継続できるようにする
enableVoicebooleantrue音声キャプチャ入口を表示するかどうか(視覚障害者向けアクセシビリティ対応)

サーバー側検証

After onSuccess, send res.token (prefix pt_) to your own backend, then validate it server-side:

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": "<token>", "client_ip": "<end-user IP>" }

完全な検証エンドポイントは API リファレンス を参照。

MIT-licensed examples · CaptchaLa is operated independently