集成 SDK

GEELAB 分别提供 Web、iOS 和 Android 客户端 SDK。请选择与接入端平台匹配的 SDK，不要跨平台混用 Public API Key。

发布前补充要求 当前产品资料没有包含已确认的 SDK 包名、最低版本、安装命令、初始化方法和正式代码示例。本节中的代码块是文档占位结构，不可直接发布为可执行代码。正式发布前，必须由 SDK 负责人按当前稳定版本补齐并验证。

通用初始化参数

不同平台的参数名称可能不同，但通常需要以下信息：

参数	是否必需	说明
Public API Key	是	从当前接入端复制，用于标识客户端请求来源
Region 或 API Endpoint	视 SDK 而定	必须与应用所属 Region 一致
超时时间	建议设置	避免识别请求长时间阻塞业务流程
业务关联字段	视业务需要	用于关联账号、订单或操作场景；不要上传不必要的敏感信息
调试日志	仅测试环境	正式环境建议关闭或脱敏

初始化原则：

在需要识别的业务流程之前完成 SDK 初始化。
Public API Key 必须来自当前平台对应的接入端。
不要将 Region 服务端密钥传入客户端 SDK。
识别失败时应有业务降级方案，不应让 SDK 异常导致整个页面或 App 崩溃。
对登录、交易等关键动作，应保存 request_id，用于后续服务端查询和故障排查。

Web SDK 快速接入

第一步：安装或加载 SDK

请使用 GEELAB Web SDK 正式文档提供的包管理器命令或加载方式。

# 待 SDK 负责人补充并验证：Web SDK 安装命令

第二步：初始化 SDK

// 示例结构，非可执行代码。请替换为正式 SDK API。
const client = initializeGeelab({
  publicKey: "<YOUR_PUBLIC_API_KEY>",
  region: "<YOUR_REGION>"
});

第三步：发起识别

// 示例结构，非可执行代码。请替换为正式 SDK API。
const result = await client.identify();

console.log(result.requestId);
console.log(result.deviceId);

建议在测试环境中临时记录 Request ID，验证成功后关闭包含设备信息的非必要日志。

iOS SDK 快速接入

第一步：添加 SDK 依赖

请按正式 iOS SDK 文档，通过当前支持的依赖管理方式添加 SDK。

// 待 SDK 负责人补充并验证：iOS SDK 安装与 import 代码

第二步：初始化并发起识别

// 示例结构，非可执行代码。请替换为正式 SDK API。
let client = GeelabClient(
    publicKey: "<YOUR_PUBLIC_API_KEY>",
    region: "<YOUR_REGION>"
)

client.identify { result in
    // 读取 requestId 和 deviceId
}

确认 App 的 Bundle ID 与接入端中配置的值完全一致。如果测试版和正式版使用不同 Bundle ID，请分别验证。

Android SDK 快速接入

第一步：添加 SDK 依赖

请按正式 Android SDK 文档，在项目中添加当前稳定版本依赖。

// 待 SDK 负责人补充并验证：Android SDK Gradle 依赖

第二步：初始化并发起识别

// 示例结构，非可执行代码。请替换为正式 SDK API。
val client = GeelabClient(
    publicKey = "<YOUR_PUBLIC_API_KEY>",
    region = "<YOUR_REGION>"
)

client.identify { result ->
    // 读取 requestId 和 deviceId
}

确认实际安装包的 Package Name 和 App Signature 与接入端配置一致。特别注意 Debug 与 Release 构建可能使用不同签名。

将识别结果接入业务流程

客户端获得 request_id 和 device_id 后，建议将 request_id 随业务请求发送到自己的服务端。服务端可以使用它查询可信事件详情，并结合账号、订单或操作上下文执行风险策略。

客户端 SDK 识别
   │
   ├── request_id
   └── device_id
          ↓
客户业务服务端
   │
   ├── 关联账号 / 订单 / 操作
   ├── 使用服务端 API 查询可信详情
   └── 决定放行 / 增强验证 / 限制 / 阻断

不要仅依赖客户端自行上报的风险结果执行高风险决策。涉及登录、交易或权益发放时，建议由可信服务端查询或验证事件结果。

图示：客户端与服务端数据流

集成 SDK

On this page