GeeTest

https://docs.geetest.com
Admin
GeeTest is a leading interactive security service provider that offers one-stop CAPTCHA, identity...
Tokens:325,810
Snippets:3,563
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and run the demo

Source: https://docs.geetest.com/sensebot/deploy/server/node/index.html

Commands to install dependencies and start the Node.js application.

```bash
cd gt3-server-node-express-sdk
sudo npm install
sudo node app.js
```

--------------------------------

### Run the Demo Application

Source: https://docs.geetest.com/sensebot/deploy/server/php/index.html

Commands to install dependencies and start the local development server for the demo.

```bash
cd gt3-server-php-laravel-sdk
sudo cp .env.example .env
sudo composer install
sudo php artisan serve --host=0.0.0.0 --port=8889
```

--------------------------------

### Run the demo application

Source: https://docs.geetest.com/sensebot/deploy/server/python/index.html

Commands to install dependencies and start the Flask server.

```bash
cd gt3-server-python-flask-sdk
sudo pip install -r requirements.txt
sudo python3 app.py
```

--------------------------------

### Run the Ruby Demo

Source: https://docs.geetest.com/sensebot/deploy/server/ruby

Install dependencies and start the Rails server to run the demo application.

```bash
cd gt3-server-ruby-rails-sdk
sudo bundle install
sudo rails server -b 0.0.0.0 -p 3000
```

--------------------------------

### Run GT4 Python Demo

Source: https://docs.geetest.com/gt4/deploy/server/python/index.html

Commands to install dependencies and start the local demonstration server.

```bash
cd gt4-python-demo  
pip install -r requirements.txt  
python3 start.py  
```

--------------------------------

### Start SDK

Source: https://docs.geetest.com/deepknowpro/apirefer/API_deepknowpro/iOS

Starts the DeepKnow SDK services.

```objective-c
- (void)start;
```

--------------------------------

### Full Verification Flow Example

Source: https://docs.geetest.com/gt4/deploy/client/harmonyos

Complete example showing configuration, client initialization, and verification execution.

```typescript
onClick(() => {  
    gtCaptcha4Config: GTCaptcha4Config =  new GTCaptcha4Config()  
            .setIsDebug(false) // TODO 线上务必关闭  
            .setLanguage("zh")  
            .setTimeOut(10000)  
            .setIsCanceledOnTouchOutside(true);  
    gtCaptcha4Client: GTCaptcha4Client = GTCaptcha4Client.getClient()  
            .init("your captcha_id", config)  
            .addOnSuccessListener({  
            async onSuccess(status: boolean, response: string) {  
              AlertDialog.show({ message: response })  
                if(status){  
                    // TODO 开启二次验证  
                }else {  
                    // TODO 用户答案验证错误  
                }  
            }  
          })  
           .addOnFailureListener({  
             onFailure: function (error: string) {  
               console.log('onFailure' + error);  
             }  
          })  
           .addOnWebViewShowListener({  
             onWebViewShow: function () {  
               console.log(`onWebViewShow`);  
             }  
          })  
           .verifyWithCaptcha();  
})
```

--------------------------------

### startCustomFlow()

Source: https://docs.geetest.com/sensebot/apirefer/api/harmonyos

Starts the verification process.

```APIDOC
## startCustomFlow()

### Description
Initiates the custom verification flow.
```

--------------------------------

### Start Node.js Demo

Source: https://docs.geetest.com/gt4/deploy/server/node/index.html

Command to initialize the demo server application.

```bash
npm start
```

--------------------------------

### Run the Demo Application

Source: https://docs.geetest.com/sensebot/deploy/server/csharp

Navigate to the SDK directory and start the application using the dotnet CLI.

```bash
cd gt3-server-csharp-aspnetcoremvc-sdk
sudo dotnet watch run
```

--------------------------------

### Initialize Configuration Parameters

Source: https://docs.geetest.com/sensebot/deploy/client/android

Configure the GT3ConfigBean and start the custom verification flow.

```java
// 配置bean文件，也可在oncreate初始化  
gt3ConfigBean = new GT3ConfigBean();  
// 设置验证模式，1：bind，2：unbind  
gt3ConfigBean.setPattern(1);  
// 设置点击灰色区域是否消失，默认不消息  
gt3ConfigBean.setCanceledOnTouchOutside(false);  
// 设置语言，如果为null则使用系统默认语言  
gt3ConfigBean.setLang(null);  
// 设置加载webview超时时间，单位毫秒，默认10000，仅且webview加载静态文件超时，不包括之前的http请求  
gt3ConfigBean.setTimeout(10000);  
// 设置webview请求超时(用户点选或滑动完成，前端请求后端接口)，单位毫秒，默认10000  
gt3ConfigBean.setWebviewTimeout(10000);  
// 设置回调监听  
gt3ConfigBean.setListener(new GT3Listener());  
gt3GeetestUtils.init(gt3ConfigBean);  
// 开启验证  
gt3GeetestUtils.startCustomFlow();  
```

--------------------------------

### Pre-tokenization Implementation

Source: https://docs.geetest.com/onelogin/deploy/android/normalmode/index.html

Example of initializing the SDK and performing pre-tokenization with a listener to handle the result.

```java
OneLoginHelper  
        .with()  
        .setLogEnable(true)  
        //第一个参数为当前 Application 或 Activity 的 Context  
        //第二个参数为所需要配置的 APPID  
        .init(context, APPID)  
        .preGetToken("", new AbstractOneLoginListener() {  
            @Override  
            public void onResult(JSONObject jsonObject) {  
                oneLoginResult.onResult();  
                Log.i(TAG, "预取号结果为：" + jsonObject.toString());  
                try {  
                    int status = jsonObject.getInt("status");  
                    // status=200 为预取号成功，其他返回码请参考返回码章节  
                    if (status == 200) {  
                        if (isRequestToken) { // 预取号成功后，可以调用拉起授权页  
                            oneLoginRequestToken();  
                        }  
                    } else {  
                        ToastUtils.toastMessage(context, "预取号失败:" + jsonObject.toString());  
                    }  
                } catch (JSONException e) {  
                    ToastUtils.toastMessage(context, "预取号失败:" + jsonObject.toString());  
                }  
            }  
        });  
    };
```

--------------------------------

### Configuring Additional Parameters

Source: https://docs.geetest.com/gt4/apirefer/api/ios/index.html

Example of setting up additional parameters for the verification session.

```Objective-C
#define captchaID @"1234567890abcdef"  
  
GTCaptcha4SessionConfiguration *config = [GTCaptcha4SessionConfiguration defaultConfiguration];  
  
NSMutableDictionary *params = [@{} mutableCopy];  
[params setValue:@(1.25)                  forKey:@"rem"]; // 放大 1.25 倍  
[params setValue:@[@"close", @"refresh"]  forKey:@"hideBar"]; // 隐藏关闭按钮及刷新按钮  
[params setValue:@"300px"                 forKey:@"nextWidth"];  
[params setValue:@"click"                 forKey:@"riskType"]; // 指定智能点击形式验证，需与后端配置一致  
[params setValue:@(1)                     forKey:@"hideSuccess"]; // 使用 NSNumber 表示布尔值  
[params setValue:@"./gt4-loading.gif"     forKey:@"loading"];  
  
config.additionalParameter = params;  
  
GTCaptcha4Session *captchaSession = [GTCaptcha4Session sessionWithCaptchaID:captchaID configuration:config];  
...
```

--------------------------------

### GET /register

Source: https://docs.geetest.com/sensebot/apirefer/api/server

Initializes the verification process.

```APIDOC
## GET /register

### Description
Initializes the verification process and returns the necessary challenge parameters.

### Method
GET

### Endpoint
/register

### Parameters
#### Query Parameters
- **t** (string) - Required - Time stamp

### Request Example
t=1592814394125

### Response
#### Success Response (200)
- **success** (int) - Process status identifier (1 for normal, 0 for downtime mode)
- **new_captcha** (bool) - New captcha identifier
- **challenge** (string) - Unique identifier for the verification flow
- **gt** (string) - Account ID

#### Response Example
{
    "success": 1,
    "new_captcha": true,
    "challenge": "2b36836f0b4ec6e6e0225e1da4ccdeb2",
    "gt": "c9c4facd1a6feeb80802222cbb74ca8e"
}
```

--------------------------------

### Implement Verification Callbacks

Source: https://docs.geetest.com/gt4/deploy/client/android

Example implementation of success, failure, and WebView show listeners.

```java
gtCaptcha4Client.addOnSuccessListener(new GTCaptcha4Client.OnSuccessListener() {  
    @Override  
    public void onSuccess(boolean status, String response) {  
        if(status){  
            // TODO 开启二次验证  
        }else {  
            // TODO 用户答案验证错误  
        }  
    }  
}).addOnFailureListener(new GTCaptcha4Client.OnFailureListener() {  
    @Override  
    public void onFailure(String error) {  
    }  
}).addOnWebViewShowListener(new GTCaptcha4Client.OnWebViewShowListener() {  
      @Override  
      public void onWebViewShow() {  
      }  
  })
```

--------------------------------

### GET /register.php

Source: https://docs.geetest.com/sensebot/apirefer/api/server

Initializes the verification process by requesting a challenge string from the Geetest server.

```APIDOC
## GET /register.php

### Description
Initializes the verification process to obtain a challenge string required for subsequent validation.

### Method
GET

### Endpoint
http://api.geetest.com/register.php

### Parameters
#### Query Parameters
- **user_id** (string) - Optional - Unique identifier for the terminal user.
- **client_type** (string) - Optional - Client type: web, h5, native, or unknown.
- **ip_address** (string) - Optional - IP address of the client requesting the SDK server.
- **digestmod** (string) - Required - Signature algorithm, default is md5.
- **gt** (string) - Required - Account ID registered with Geetest.
- **json_format** (string) - Required - JSON formatting flag.
- **sdk** (string) - Required - SDK code version number.

### Request Example
user_id=test&client_type=web&ip_address=127.0.0.1&digestmod=md5&gt=c9c4facd1a6feeb80802222cbb74ca8e&json_format=1

### Response
#### Success Response (200)
- **challenge** (string) - Reference string for generating a unique serial number.

#### Response Example
{
    "challenge": "b324874b39840757544e33bf4b60cb80"
}
```

--------------------------------

### DeepKnow Initialization

Source: https://docs.geetest.com/deepknow/deploy/sensebot/ios/index.html

Initializes and starts the DeepKnow SDK within the application delegate.

```APIDOC
## [DeepKnow sharedInstance] start

### Description
Initializes the DeepKnow singleton and starts the SDK service.

### Method
Objective-C Method

### Signature
[DeepKnow sharedInstance] start

### Usage
```objectivec
DeepKnow *deepknow = [DeepKnow sharedInstance];
[deepknow start];
```
```

--------------------------------

### Run the Demo Application

Source: https://docs.geetest.com/sensebot/deploy/server/golang/index.html

Navigate to the SDK directory and execute the main entry point to start the server.

```bash
cd gt3-server-golang-gin-sdk
sudo go run main.go
```

--------------------------------

### Start and Stop SDK

Source: https://docs.geetest.com/deepknowpro/apirefer/API_deepknowpro/iOS/index.html

Methods to start or stop the DeepKnow SDK operations.

```objective-c
- (void)start;
- (void)stop;
```

--------------------------------

### GlanceResult JSON Response Example

Source: https://docs.geetest.com/themis/deploy/android/index.html

Example of the JSON structure returned by the analysis task.

```json
{
    "task_id": "9fda765161fef47aaa6d0d9e8d0daab6",
    "content": "他们集体罢课了",
    "result": [
        {
            "keyword": "罢课",
            "risk_level": "b",
            "category": "涉政",
            "start": 4,
            "end": 6
        }
    ],
    "client_type": "Android",
    "merchant_id": "4c73730ddc83ebc6f9b0af0d0e350590",
    "package_name": "com.geetest.glancedemo",
    "release": "10",
    "model": "MI 9",
    "status": "200",
    "msg": "Success"
}
```

--------------------------------

### init(GT3ConfigBean)

Source: https://docs.geetest.com/sensebot/apirefer/api/android

Initializes the SDK with the provided configuration.

```APIDOC
## init(GT3ConfigBean)

### Description
Initializes the verification service using the provided configuration bean.

### Parameters
- **bean** (GT3ConfigBean) - Required - The configuration object.
```

--------------------------------

### Failure Response Example

Source: https://docs.geetest.com/BehaviorVerification/apirefer/api/android/index.html

Example of the JSON response data returned when verification fails.

```json
{"captchaId":"647f5ed2ed8acb4be36784e01556bb71","captchaType":"slide","challenge":"95ed53b4-95c6-4c6b-9aac-769b29ef74a0"}
```

--------------------------------

### Bypass Request Parameter Example

Source: https://docs.geetest.com/sensebot/apirefer/api/server

Example of the required gt parameter for the bypass status request.

```text
gt=c9c4facd1a6feeb80802222cbb74ca8e  
```

--------------------------------

### GTCaptcha4Client Success Response Example

Source: https://docs.geetest.com/gt4/apirefer/api/harmonyos

Example JSON structure returned upon successful verification.

```json
{"lot_number":"b150e61198924eff9eaae121e9b67aa8","pass_token":"6fcfba4c35cb57b873c99c5b3b02089c58a26244c18f7706aaa1e87aed3aa8f4","gen_time":"1622020720","captcha_output":"Tu6rW0dRNO0NLxMKftwdH00G5whF5HHddthoXSEA1G4="}
```

--------------------------------

### Load Failure Error Example

Source: https://docs.geetest.com/BehaviorVerification/apirefer/api/android/index.html

Example of the JSON error structure returned during a load failure.

```json
{"code":"-14460","msg":"Captcha session is canceled","desc":{"description":"User cancelled 'Captchas'"}}
```

--------------------------------

### Success Response Example

Source: https://docs.geetest.com/BehaviorVerification/apirefer/api/android/index.html

Example of the JSON response data returned upon successful verification.

```json
{"lot_number":"b150e61198924eff9eaae121e9b67aa8","pass_token":"6fcfba4c35cb57b873c99c5b3b02089c58a26244c18f7706aaa1e87aed3aa8f4","gen_time":"1622020720","captcha_output":"Tu6rW0dRNO0NLxMKftwdH00G5whF5HHddthoXSEA1G4="}
```

--------------------------------

### Initialize SDK

Source: https://docs.geetest.com/themis/deploy/android/index.html

Define the initialization method and provide a usage example for the Application's onCreate method.

```java
public GeeGlance init(Context context, String merchantId);  
```

```java
GeeGlance  
        .with()  
        //开启 SDK 日志打印功能  
        .setLogEnable(true)  
        //第一个参数为当前 Application 或 Activity 的 Context  
        //第二个参数为注册申请商户 ID的 MERCHANT_ID  
        .init(this, MERCHANT_ID);  
```

--------------------------------

### GTCaptcha4Client Failure Response Example

Source: https://docs.geetest.com/BehaviorVerification/apirefer/api/harmonyos

Example JSON payload describing a captcha load failure.

```json
{"code":"-34460","msg":"Captcha session is canceled","desc":{"description":"User cancelled 'Captchas'"}}
```

--------------------------------

### init()

Source: https://docs.geetest.com/sensebot/apirefer/api/harmonyos

Initializes the verification service.

```APIDOC
## init()

### Description
Initializes the Geetest verification service.
```

--------------------------------

### Bypass Response Examples

Source: https://docs.geetest.com/sensebot/apirefer/api/server

Examples of JSON responses from the bypass status endpoint indicating service health.

```json
请求响应正常时：  
{"status": "success"}  表示当前极验服务状态正常  
{"status": "fail"}  表示当前极验服务状态异常  
  
请求响应异常时：  
如果发送请求后出现请求超时或者返回状态码为非 200 时，请将极验服务状态标识为异常  
```

--------------------------------

### Full Verification Workflow

Source: https://docs.geetest.com/BehaviorVerification/deploy/client/harmonyos

Complete example showing configuration, initialization, and triggering verification within an onClick event.

```typescript
onClick(() => {  
    gtCaptcha4Config: GTCaptcha4Config = new GTCaptcha4Config()  
        .setIsDebug(false) // TODO Disable in production  
        .setLanguage("zh")  
        .setTimeOut(10000)  
        .setIsCanceledOnTouchOutside(true);  
    gtCaptcha4Client: GTCaptcha4Client = GTCaptcha4Client.getClient()  
        .init("your captcha_id", config)  
        .addOnSuccessListener({  
        async onSuccess(status: boolean, response: string) {  
          AlertDialog.show({ message: response })  
            if(status){  
                // TODO Start secondary verification  
            }else {  
                // TODO User answer verification failed  
            }  
        }  
      })  
       .addOnFailureListener({  
         onFailure: function (error: string) {  
           console.log('onFailure' + error);  
         }  
      })  
       .addOnWebViewShowListener({  
         onWebViewShow: function () {  
           console.log(`onWebViewShow`);  
         }  
      })  
       .verifyWithCaptcha();  
})
```

--------------------------------

### Session Result JSON Example

Source: https://docs.geetest.com/deepknowpro/apirefer/API_deepknowpro/HarmonyOS

Example structure of the JSON object returned by the session result callback.

```json
{
    "status":1,
    "message":"ok",
    "session_id":"dec6ba16-01d3-4a83-b063-bcaf87c7d3bd"
}
```

--------------------------------

### GTCaptcha4Client Success Response Examples

Source: https://docs.geetest.com/BehaviorVerification/apirefer/api/harmonyos

Example JSON payloads for successful and failed verification results returned to the onSuccess callback.

```json
{"lot_number":"b150e61198924eff9eaae121e9b67aa8","pass_token":"6fcfba4c35cb57b873c99c5b3b02089c58a26244c18f7706aaa1e87aed3aa8f4","gen_time":"1622020720","captcha_output":"Tu6rW0dRNO0NLxMKftwdH00G5whF5HHddthoXSEA1G4="}
```

```json
{"captchaId":"647f5ed2ed8acb4be36784e01556bb71","captchaType":"slide","challenge":"95ed53b4-95c6-4c6b-9aac-769b29ef74a0"}
```

--------------------------------

### Run Golang Demo

Source: https://docs.geetest.com/gt4/deploy/server/golang/index.html

Command to execute the main entry point of the GT4 Golang demo application.

```bash
go run main.go
```

--------------------------------

### Verify API Request Parameters Example

Source: https://docs.geetest.com/deepknowpro/apirefer/API_deepknowpro/server/index.html

Example of the JSON structure required for the verify API request body before JWT encoding.

```json
{
    "session_id" : "5d03ec51309cac984f5c3c0b699b78f5",
    "user_id" : "user001",
    "user_email": "user001@test.com",
    "phone_num": "12345678902",
    "flow_id": 1,//未启用处理引擎的客户不需传该字段
    "scene": "login",
    "attr":{
        "nick_name": "geetest"
    }
}
```

--------------------------------

### Verify API Response Example

Source: https://docs.geetest.com/deepknowpro/apirefer/API_deepknowpro/server/index.html

Example of the JSON response returned by the verify API, containing risk assessment data and device information.

```json
{
    "challenge": "662a6a1b964f9d49f5ed1b3b6f046861",
    "private_action": ['malicious_account_warn', 'debug_warn'],
    "action": "block",
    "finger_print": "DFBHNXLVUJCIFWZQY5SMCTMGQVN4J4EL",
    "message": "ok",
    "risk_code": [4006],
    "risk_level": 7,
    "status": 1,
    "info": {
        "client_type": "android",
        "ip": "58.48.167.299",
        "refer": "https://www.google.com/",
        "ua": "Go-http-client/1.1",
        "package_name":"com.geetest.deepknow.harmonyos.demo",
        "package_sign":"F35FE4ADF853AE5B72C0BA82593104E341E7750287808B8F96F36D7A90539B7A"
    }
}
```

--------------------------------

### Clone the demo repository

Source: https://docs.geetest.com/sensebot/deploy/server/python/index.html

Use git to download the project source code from the official repository.

```bash
git clone https://github.com/GeeTeam/gt3-server-python-flask-bypass.git
```

--------------------------------

### GTCaptcha4Client.verifyWithCaptcha

Source: https://docs.geetest.com/BehaviorVerification/deploy/client/harmonyos

Starts the verification process.

```APIDOC
## GTCaptcha4Client.verifyWithCaptcha()

### Description
Triggers the start of the verification process.
```

--------------------------------

### Full Initialization and Event Handling

Source: https://docs.geetest.com/deepknow/deploy/sensebot/web/index.html

Complete initialization including error handling, data submission, and success callbacks.

```javascript
initSense({  
    id:'95da05c7809ec08cf97cfb2e932cd381',          
    onError:function(err){  
        console.log('gt error', err)  
    }  
}, function(sense){  
    $('#btn').click(function () {  
        // 请先检查必现输入的数据， 例如：用户名，密码  
  
        sense.sense()  
    });  
    sense.setInfos(function () {  
        //设置可上传数据。请务必按照字段规范填写，否则会在服务验证时出错，导致程序无法运行或者后续数据分析出现混乱，参数需求参考api文档。  
        return {  
            interactive: 1  
        }  
    }).onSuccess(function (data) {  
        $.ajax({  
            url: '您的服务',  
            type: "post",  
            dataType: "json",  
            data: {  
                phone: document.getElementById("phone"),  
                password: document.getElementById("password"),                      
                challenge: data.challenge  
            },  
            success: function (result) {  
                console.log(result);  
            }  
        })  
    }).onClose(function(){  
        console.log('close')  
    }).onError(function(err){  
        console.log(err);  
    })  
});  
```

--------------------------------

### Verify with Captcha

Source: https://docs.geetest.com/gt4/deploy/client/harmonyos

Start the verification process.

```typescript
public void verifyWithCaptcha();  
```

--------------------------------

### Start Verification

Source: https://docs.geetest.com/gt4/deploy/client/android

Triggers the verification flow.

```java
public void verifyWithCaptcha();
```

--------------------------------

### load(config)

Source: https://docs.geetest.com/guard/deploy/miniprogram/minigame

初始化 SDK 并获取 gee_token。该方法返回一个 Promise，成功时返回包含 gee_token 的对象，失败时抛出异常。

```APIDOC
## load(config)

### Description
初始化极验小游戏 SDK 并获取用于业务验证的 gee_token。

### Parameters
- **config** (Object) - Required - 配置对象
  - **appId** (String) - Required - 极验应用 ID

### Returns
- **Promise** - 成功时返回 { gee_token: string }，失败时返回异常信息

### Example
```javascript
import {load} from './plugin/components/guard/guard';

load({appId: 'xxxxxxxxxxxxxxx'})
  .then((data) => {
    // data { gee_token : 'xxxxxxxxxxxxxxxxxxxxxxxxxxxx' }
  })
  .catch((e) => {
    // 捕获异常
  });
```
```

--------------------------------

### startGTCaptchaWithAnimated:

Source: https://docs.geetest.com/captcha/apirefer/api/ios/index.html

Starts the captcha verification process.

```APIDOC
## - (void)startGTCaptchaWithAnimated:(BOOL)animated

### Description
Start the verification.

### Parameters
- **animated** (BOOL) - If `YES`, the captcha is being started and using animation.
```

--------------------------------

### Configuring the Authorization Dialog

Source: https://docs.geetest.com/onelogin/deploy/ios

Example showing how to set up the authorization dialog properties using the view model.

```objective-c
// 是否显示授权弹窗，不显示的话在未授权时会弹出请同意服务条款提示  
viewModel.willAuthDialogDisplay = YES;  
// 弹窗是否显示在底部，为 NO 时弹窗会在屏幕中间显示  
viewModel.isAuthDialogBottom = YES;  
// 弹窗尺寸、圆角大小及位置  
OLRect authDialogRect = {0, 0, 0, 0, 0, 0, {[UIScreen mainScreen].bounds.size.width, 340}};  
viewModel.authDialogRect = authDialogRect;  
viewModel.authDialogCornerRadius = 8;  
viewModel.authDialogRectCorners = @[@(UIRectCornerTopLeft), @(UIRectCornerTopRight)];  
  
// 弹窗动画  
viewModel.authDialogAnimationStyle = OLAuthDialogAnimationStyleCoverVertical;  
  
// 弹窗标题、内容设置  
viewModel.authDialogTitleFont = [UIFont systemFontOfSize:20];  
viewModel.authDialogTitleText = @"请同意下述服务条款";  
viewModel.authDialogTitleColor = [UIColor blackColor];  
viewModel.authDialogContentFont = [UIFont systemFontOfSize:14];  
  
// 同意按钮设置  
viewModel.authDialogAgreeBtnFont = [UIFont systemFontOfSize:16];  
viewModel.authDialogAgreeBtnText = @"同意并继续";  
viewModel.authDialogAgreeBtnColor = [UIColor whiteColor];  
  
// 不同意按钮设置  
viewModel.authDialogDisagreeBtnFont = [UIFont systemFontOfSize:16];  
viewModel.authDialogDisagreeBtnText = @"不同意并返回";  
viewModel.authDialogDisagreeBtnColor = [UIColor blackColor];  
  
// 是否可以点击弹窗外区域关闭弹窗，默认为 YES  
viewModel.canCloseAuthDialogFromTapGesture = NO;  
// 点击弹窗外区域关闭弹窗的回调  
viewModel.tapAuthDialogBackgroundBlock = ^{
    NSLog(@"tapAuthDialogBackgroundBlock");
};
// 点击不同意按钮关闭弹窗的回调  
viewModel.clickAuthDialogDisagreeBtnBlock = ^{
    NSLog(@"clickAuthDialogDisagreeBtnBlock");
};
```

--------------------------------

### verify

Source: https://docs.geetest.com/BehaviorVerification/apirefer/api/ios/index.html

Starts the captcha verification process.

```APIDOC
## - (void)verify

### Description
Start verification process for the current session.
```

--------------------------------

### PHP Implementation for /gt_verify

Source: https://docs.geetest.com/deepknow/deploy/deepknow/server/index.html

Example showing how to prepare the data array, generate the MD5 signature, and send a POST request using file_get_contents in PHP.

```php
<?php  
	$challenge = $_POST['challenge'];  
	$username = $_POST['username'];  
	$privateKey = "4f1c085290bec5afdc54df73535fc361";  
	$seccode = md5($privateKey . $challenge);  
	$data = array(  
	    "idType"=>1,  # 用户标识符的类型：1:手机号2:邮箱3:昵称4:UID,用户站内编号0:其他  
	    "idValue"=>$username, # string  idType 对应的值  
	    "seccode"=>$seccode, # 必传  string  私钥+challenge md5的签名  
	    "challenge"=>$challenge,  # 必传  string  查询结果的凭证, 从前一个接口返回  
	    "user_ip"=>"127.0.0.1", # 必传  string  用户真实访问网站的ip  
	    "timestamp"=>(int)time()   # 必传  int 用户发起对应事件交互行为时的时间戳  
	);  
	// var_dump($data);  
	$data = http_build_query($data);  
	$url = "http://api.geetest.com/gt_verify";  
	$opts = array(  
	    'http' => array(  
	        'method'  => 'POST',  
	        'header'  => "Content-type: application/x-www-form-urlencoded\r\n" . "Content-Length: " . strlen($data) . "\r\n",  
	        'content' => $data,  
	        'timeout' => 2  
	    )  
	);  
	$context = stream_context_create($opts);  
	$res = file_get_contents($url, false, $context);  
	echo $res;  
 ?>  
```

--------------------------------

### Initialize and Request Token in iOS

Source: https://docs.geetest.com/onelogin/quick_integration_guide

Demonstrates initializing the OneLoginPro SDK and handling the token request process within an iOS view controller.

```objective-c
#import <OneLoginSDK/OneLoginSDK.h>  
  
- (void)viewDidLoad {  
  [super viewDidLoad];  
  [OneLoginPro registerWithAppID:GTOneLoginAppId];  
}  
  
- (IBAction)oneLoginAction:(UIButton *)sender {  
  OLAuthViewModel *viewModel = [OLAuthViewModel new];  
  if (![OneLoginPro isPreGetTokenResultValidate]) {  
    // 展示 loading，等待 SDK 内部预取号完成。  
  }  
  
  [OneLoginPro requestTokenWithViewController:self  
                                    viewModel:viewModel  
                                   completion:^(NSDictionary * _Nullable result) {  
    // result 中读取 process_id、token、authcode，提交业务服务端。  
  }];  
}  
```

--------------------------------

### Start Verification

Source: https://docs.geetest.com/captcha/apirefer/api/ios/index.html

Initiates the captcha verification process.

```objective-c
- (void)startGTCaptchaWithAnimated:(BOOL)animated;
```

--------------------------------

### Initialize Geetest with Popup Product Mode

Source: https://docs.geetest.com/sensebot/apirefer/api/web

Configures the verification interface to use the popup display style.

```javascript
initGeetest({  
    // 省略必须的配置参数  
  
    product: 'popup'  
}, function (captchaObj) {  
    captchaObj.appendTo("#captchaBox"); //将验证按钮插入到宿主页面中captchaBox元素内  
    captchaObj.onReady(function(){
      //your code  
    }).onSuccess(function(){
      //your code  
    }).onError(function(){
      //your code  
    })
})  

```

--------------------------------

### Preload and normal loading patterns

Source: https://docs.geetest.com/gt4/deploy/client/android

Examples for initializing the captcha client with GTCaptcha4Config and handling success/failure callbacks.

```java
@Override  
public void onViewCreated(View view, Bundle savedInstanceState){  
    super.onViewCreated(view, savedInstanceState);  
    GTCaptcha4Config config = new GTCaptcha4Config.Builder()  
            .setDebug(true) // TODO 线上务必关闭  
            .setLanguage("zh")  
            .setTimeOut(10000)  
            .setCanceledOnTouchOutside(true)  
            .build();  
    gtCaptcha4Client = GTCaptcha4Client.getClient(activity)  
            .init("your captcha_id", config);  
}  
  
private void click(){  
    gtCaptcha4Client.addOnSuccessListener(new GTCaptcha4Client.OnSuccessListener {  
                @Override  
                public void onSuccess(boolean status, String response) {  
                    if(status){  
                        // TODO 开启二次验证  
                    }else {  
                        // TODO 用户答案验证错误  
                    }  
                }  
            })  
            .addOnFailureListener(new GTCaptcha4Client.OnFailureListener {  
                @Override  
                public void onFailure(String error) {  
                }  
            })  
            .verifyWithCaptcha();  
}  
```

```java
private void click(){  
    GTCaptcha4Config config = new GTCaptcha4Config.Builder()  
            .setDebug(true) // TODO 线上务必关闭  
            .setLanguage("zh")  
            .setTimeOut(10000)  
            .setCanceledOnTouchOutside(true)  
            .build();  
    gtCaptcha4Client = GTCaptcha4Client.getClient(activity)  
            .init("your captcha_id", config)  
            .addOnSuccessListener(new GTCaptcha4Client.OnSuccessListener {  
                @Override  
                public void onSuccess(boolean status, String response) {  
                    if(status){  
                        // TODO 开启二次验证  
                    }else {  
                        // TODO 用户答案验证错误  
                    }  
                }  
            })  
            .addOnFailureListener(new GTCaptcha4Client.OnFailureListener {  
                @Override  
                public void onFailure(String error) {  
                }  
            })  
            .verifyWithCaptcha();  
}  
```

--------------------------------

### verify

Source: https://docs.geetest.com/BehaviorVerification/apirefer/api/ios

Starts the verification process for the current session.

```APIDOC
## - (void)verify

### Description
Starts the verification process.
```

--------------------------------

### Start verification

Source: https://docs.geetest.com/BehaviorVerification/apirefer/api/ios

Method to initiate the verification process.

```objective-c
- (void)verify;
```

--------------------------------

### Java Implementation for /gt_verify

Source: https://docs.geetest.com/deepknow/deploy/deepknow/server/index.html

Example showing how to construct the request parameters, calculate the MD5 seccode, and perform a POST request in Java.

```java
  
String  challenge = request.getParameter("challenge");  
String userName = request.getParameter("username");  
  
 Date date = new Date();  
long timestamp = date.getTime()/1000;  
String privateKey = "4f1c085290bec5afdc54df73535fc361";  //您的私钥, 在极验后台获取  
String seccode = "";  
try {  
	seccode  = getMD5(privateKey + challenge);  
} catch (Exception e) {  
	// TODO Auto-generated catch block  
	e.printStackTrace();  
}  
  
HashMap<String, Object>  params = new HashMap<>();  
params.put("seccode",  seccode);  
params.put("idType",  1);  
params.put("idValue",  userName);  
params.put("challenge",  challenge);  
params.put("user_ip",  "1.2.3.4");  
params.put("timestamp",  "" + timestamp);  
post(params);  
```

--------------------------------

### Initialize and Fetch Tokens in HarmonyOS Next

Source: https://docs.geetest.com/guard/quick_integration_guide

Register the GeeGuard SDK in the AbilityStage and use fetch or submit methods to retrieve tokens for server-side verification.

```typescript
export default class MainAbilityStage extends AbilityStage {  
  private static readonly GEEGUARD_APP_ID = "你的 appId";  
  
  onCreate() {  
    GeeGuard.register(this.context, MainAbilityStage.GEEGUARD_APP_ID);  
  }  
}  
  
async function getGeeToken(context: Context, businessId: string) {  
  const receipt = await GeeGuard.fetchReceipt(context, businessId);  
  if (!receipt || !receipt.geeToken) return;  
  // 提交 receipt.geeToken 到业务服务端。  
}  
  
function getRespondedGeeToken(context: Context, businessId: string) {  
  GeeGuard.submitReceipt(context, businessId, {  
    onCompletion: (status: number, receipt: GeeGuardReceipt | undefined) => {  
      if (status === 200 && receipt?.respondedGeeToken) {  
        // 提交 receipt.respondedGeeToken 到业务服务端。  
      } else if (receipt?.geeToken) {  
        // 可降级提交 receipt.geeToken。  
      }  
    }  
  });  
}
```

--------------------------------

### Start Verification Flow

Source: https://docs.geetest.com/sensebot/apirefer/api/android

Initiates the custom verification flow.

```java
public void startCustomFlow()
```

--------------------------------

### Start Verification Flow

Source: https://docs.geetest.com/sensebot/apirefer/api/harmonyos

Initiates the custom verification process.

```typescript
public startCustomFlow()
```

--------------------------------

### Initialize SDK

Source: https://docs.geetest.com/sensebot/apirefer/api/harmonyos

Initializes the verification SDK.

```typescript
public init()
```

--------------------------------

### Configure Quick App Polyfills

Source: https://docs.geetest.com/gt4/deploy/client/miniprogram/qa/index.html

Install and inject the necessary regenerator runtime for ES5 compatibility in Quick Apps.

```javascript
npm i @babel/runtime -D  
  
const injectRef = Object.getPrototypeOf(global) || global  
  
// 注入regeneratorRuntime  
injectRef.regeneratorRuntime = require('@babel/runtime/regenerator')  
// 如果使用的 hap-toolkit 版本低于0.0.38(babel 版本低于 7)，则按下面的方式引入  
// injectRef.regeneratorRuntime = require('babel-runtime/regenerator')
```

--------------------------------

### Get Default Configuration

Source: https://docs.geetest.com/gt4/apirefer/api/ios

Retrieves a default configuration instance.

```Objective-C
+ (GTCaptcha4SessionConfiguration *)defaultConfiguration;
```

```Objective-C
+ (GTCaptcha4SessionConfiguration *)defaultConfiguration {  
    GTCaptcha4SessionConfiguration *config = [[GTCaptcha4SessionConfiguration alloc] init];  
    config.debugEnable  = NO;  
    config.timeout      = 8.0;  
    config.language     = [GTC4Utils systemLanguage];  
    config.protocol     = @"https";  
    config.userInterfaceStyle = GTC4UserInterfaceStyleDefault;  
    config.backgroundColor = [UIColor clearColor];  
    config.backgroundUserInteractionEnable = YES;  
      
    return config;  
}
```

--------------------------------

### Get Session Status

Source: https://docs.geetest.com/deepknowpro/apirefer/API_deepknowpro/iOS/index.html

Retrieves the current session status.

```objective-c
@property (nullable, atomic, readonly, copy) DPSessionStatus *sessionStatus;
```

--------------------------------

### Initialize SDK

Source: https://docs.geetest.com/deepknow/apirefer/Android_api/Android_sense/index.html

Initialize the DPAPI instance with the application context.

```java
public DPAPI (Context context,String token)
```

```java
DPAPI.getInstance(this,null);
```

--------------------------------

### init(appId: string)

Source: https://docs.geetest.com/onelogin/deploy/harmonyos

Initializes the OneLogin SDK with the provided application ID.

```APIDOC
## init(appId: string)

### Description
Initializes the SDK and configures the APPID. This should be called before other SDK operations.

### Parameters
- **appId** (string) - Required - The unique product APPID configured in the Geetest backend.

### Returns
- **OneLoginHelper** - The SDK helper instance.
```

--------------------------------

### Match Method Signature

Source: https://docs.geetest.com/themis/deploy/android

Method signature for starting content analysis.

```java
public void match(String content, GlanceConfig config, GlanceListener listener);  
```

--------------------------------

### Include Initialization Script

Source: https://docs.geetest.com/guard/deploy/web

Add the gd.js script tag to your HTML to load the device fingerprinting library.

```html
<script src="https://static.geetest.com/g5/gd.js"></script>  
// js文件会不定期升级更新，建议直接使用线上地址。  
```

--------------------------------

### actionAfterStartActivityCalled

Source: https://docs.geetest.com/onelogin/deploy/android/index.html

Callback triggered immediately after starting the authorization page activity.

```APIDOC
## public void actionAfterStartActivityCalled()

### Description
Triggered after startActivity is called. Useful for applying custom transition animations.
```

--------------------------------

### Start Captcha Flow

Source: https://docs.geetest.com/sensebot/help/faq/ios

Triggers the captcha verification process with animation.

```objective-c
- (void)startCaptcha {  
    [self.manager startGTCaptchaWithAnimated:YES];  
}
```

--------------------------------

### Initialize SDK in UIViewController

Source: https://docs.geetest.com/onelogin/deploy/ios

Implementation of SDK registration within the viewDidLoad method.

```objectivec
- (void)viewDidLoad {  
    [super viewDidLoad];      
    // 设置AppId，AppID通过后台注册获得，从极验后台获取该AppID，AppID需与bundleID配套  
    [OneLoginPro registerWithAppID:GTOneLoginAppId];  
}
```

```swift
override func viewDidLoad() {  
    super.viewDidLoad()  
    // 设置AppId，AppID通过后台注册获得，从极验后台获取该AppID，AppID需与bundleID配套  
    OneLoginPro.register(withAppID: GTOneLoginAppId)  
}
```

--------------------------------

### Initialize SDK

Source: https://docs.geetest.com/deepknow/deploy/deepknow/android/index.html

Initialize the SDK in the Application's onCreate method and declare the Application in the manifest.

```java
DPAPI.getInstance(this,null);  

```

```xml
android:name=".MyApplication"  

```

--------------------------------

### Trigger Verification

Source: https://docs.geetest.com/sensebot/deploy/client/harmonyos/index.html

Call the getGeetest method to start the verification process.

```typescript
   // 开启验证  
   
gt3GeetestUtils.getGeetest();  
```

--------------------------------

### Python Server-Side Integration Example

Source: https://docs.geetest.com/gt4/apirefer/api/server

Demonstrates how to initialize parameters, generate a HMAC-SHA256 signature, and perform the secondary validation request to the Geetest API.

```python
def post(self):  
    # 1.初始化极验参数信息  
    captcha_id = '647f5ed2ed8acb4be36784e01556bb71'  
    captcha_key = 'b09a7aafbfd83f73b35a9b530d0337bf'  
    api_server = 'http://gcaptcha4.geetest.com'  
  
    # 2.获取用户验证后前端传过来的验证参数  
    lot_number = self.get_argument('lot_number', '')  
    captcha_output = self.get_argument('captcha_output', '')  
    pass_token = self.get_argument('pass_token', '')  
    gen_time = self.get_argument('gen_time', '')  
  
    # 3.生成签名  
    # 生成签名使用标准的hmac算法，使用用户当前完成验证的流水号lot_number作为原始消息message，使用客户验证私钥作为key  
    # 采用sha256散列算法将message和key进行单向散列生成最终的签名  
    lotnumber_bytes = lot_number.encode()  
    prikey_bytes = captcha_key.encode()  
    sign_token = hmac.new(prikey_bytes, lotnumber_bytes, digestmod='SHA256').hexdigest()  
  
    # 4.上传校验参数到极验二次验证接口, 校验用户验证状态  
    query = {  
        "lot_number": lot_number,  
        "captcha_output": captcha_output,  
        "pass_token": pass_token,  
        "gen_time": gen_time,  
        "sign_token": sign_token,  
    }  
    # captcha_id 参数建议放在 url 后面, 方便请求异常时可以在日志中根据id快速定位到异常请求  
    url = api_server + '/validate' + '?captcha_id={}'.format(captcha_id)  
    # 注意处理接口异常情况，当请求极验二次验证接口异常或响应状态非200时做出相应异常处理  
    # 保证不会因为接口请求超时或服务未响应而阻碍业务流程  
    try:  
        res = requests.post(url, query)  
        assert res.status_code == 200  
        gt_msg = json.loads(res.text)  
    except Exception as e:  
        gt_msg = {'result': 'success', 'reason': 'request geetest api fail'}  
      
    # 5.根据极验返回的用户验证状态, 网站主进行自己的业务逻辑  
    if gt_msg['result'] == 'success':  
        self.write({'login': 'success', 'reason': gt_msg['reason']})  
    else:  
        self.write({'login': 'fail', 'reason': gt_msg['reason']})  
```

--------------------------------

### Control Verification Session

Source: https://docs.geetest.com/gt4/apirefer/api/ios/index.html

Methods to start or cancel the verification process.

```objective-c
- (void)verify;
```

```objective-c
- (void)cancel;
```

--------------------------------

### 初始化 GlanceView 并配置场景

Source: https://docs.geetest.com/themis/deploy/android/index.html

通过 GlanceConfig.Builder 设置场景 Key 和类型，并将其应用到 GlanceView 实例。

```java
// 初始化控件  
GlanceView etInput = (GlanceView)findViewById(R.id.et_input);  
  
// 创建场景配置  
GlanceConfig config = new GlanceConfig.Builder()  
                .setSenseKey("article")             //配置场景 key  
                .setSenseType(GlanceSenseType.LONG) // 配置场景类型  
                .build();  
etInput.setGlanceConfig(config);
```

--------------------------------

### Control GTCaptcha4Session lifecycle

Source: https://docs.geetest.com/gt4/apirefer/api/ios

Methods to start or cancel the verification process.

```objective-c
- (void)verify;
```

```objective-c
- (void)cancel;
```

--------------------------------

### initSense 初始化函数

Source: https://docs.geetest.com/static/deepknow/deploy/sensebot/web/index.html

初始化 SenseBot 验证服务，传入配置对象和回调函数以获取验证实例。

```APIDOC
## initSense(config, callback)

### Description
初始化验证服务。第一个参数为配置对象，第二个参数为回调函数，回调函数的第一个参数即为验证实例。

### Parameters
#### config (Object)
- **id** (string) - Required - 验证 id，极验后台申请得到
- **lang** (string) - Optional - 设置验证界面文字的语言，默认 'zh-cn'
- **https** (boolean) - Optional - 是否使用 https 请求，默认 false
- **timeout** (number) - Optional - 单个请求超时时间，默认 30000ms
- **area** (string) - Optional - 验证弹出的区域，默认为 body
- **width** (string) - Optional - 验证宽度，支持 260px-348px
- **bg_color** (string) - Optional - 弹出背景颜色

### Request Example
initSense({
    id: 'your_id_here',
    lang: 'en',
    https: true
}, function (sense) {
    // 使用 sense 实例
});
```
Tokens:
Raw