接入前准备
快速开始: 接入前准备
确认账号和权限
开始前,请确认当前账号已经加入目标组织,并拥有“设备指纹”产品的访问权限。
| 接入操作 | 建议权限 |
|---|---|
| 使用应用、接入端、事件和访客 | 设备指纹产品权限 |
| 创建或编辑应用和接入端 | 设备指纹产品权限 |
| 查看和复制 Public API Key | 设备指纹产品权限 |
| 配置来源校验、应用签名和限流 | 设备指纹产品权限 |
| 查看首个识别事件 | 设备指纹产品权限 |
如果控制台提示没有产品访问权限,请联系组织主账号为你开通设备指纹产品权限。首期没有单独的只读权限;获得设备指纹产品权限后,产品功能按读写一体提供。
选择接入平台
根据实际业务客户端选择接入平台:
| 平台 | 适用场景 | 创建接入端前需要准备 |
|---|---|---|
| Web | PC 网站、移动网页、H5 | 正式域名、测试域名、协议与端口 |
| iOS | 原生 iPhone 或 iPad 应用 | Bundle ID;是否启用应用签名校验 |
| Android | 原生 Android 应用 | Package Name、App Signature;是否启用应用签名校验 |
一个应用可以创建多个接入端。例如,同一个商城应用可以分别创建 Web、iOS 和 Android 接入端。每个接入端拥有独立的 Public API Key、安全校验和限流设置。
建议按照真实平台拆分接入端,不要在多个平台之间混用 Public API Key。
选择 Region
Region 决定应用数据的存储和计算区域,也是服务端密钥与 Webhook 的隔离边界。创建应用后,Region 不可修改。
选择时应考虑:
- 业务用户和数据主体所在地区。
- 企业内部的数据驻留与跨境要求。
- 已有服务端和数据处理系统所在区域。
- 后续需要绑定的 Webhook 和同区应用。
- 企业法务、安全或合规团队给出的要求。
当前控制台可能提供 EU、NA、Global 等 Region,实际可用项及服务范围以控制台和正式服务协议为准。
如果无法确定应选择哪个 Region,请先咨询企业内部合规负责人或 GEELAB 支持人员,不要仅为了测试随意选择。正式应用创建后不能直接更换 Region。
规划应用、接入端和密钥
创建前,建议先按业务边界进行简单规划。
应用如何划分
一个应用通常对应一个独立业务项目,例如:
- 商城主站。
- 支付产品。
- 营销活动平台。
- 移动银行。
当两个业务需要独立统计、独立配额或严格隔离数据时,建议创建不同应用。
接入端如何划分
一个接入端对应应用下的一个具体平台或接入入口,例如:
- 商城主站 - Web。
- 商城客户端 - iOS。
- 商城客户端 - Android。
如果同一平台的多个入口需要不同的来源校验或限流策略,也可以拆分为多个接入端。
密钥如何使用
| 密钥 | 所属对象 | 使用位置 | 是否可以放在客户端 |
|---|---|---|---|
| Public API Key | 接入端 | SDK 初始化 | 可以,但必须配置来源或应用签名校验及限流 |
| 服务端密钥 | Region | 可信服务端调用服务端 API | 不可以 |
| Webhook Bearer Token | Webhook | 客户服务端验证回调来源 | 不可以 |
本指南只需要使用 Public API Key。不要将 Region 服务端密钥写入网页、移动应用、客户端配置文件、公开仓库或客户端日志。
准备测试环境
为了验证接入,请提前准备:
- 一个可以修改和运行的测试项目。
- 对应平台的构建环境。
- 可访问 GEELAB 服务的网络。
- 一个用于触发识别的测试页面或测试操作。
- 访问控制台事件页面的权限。
Web 本地开发环境是否允许使用 localhost,以及需要配置的测试 Origin,应以 SDK 和控制台校验规则为准。正式环境应使用实际 HTTPS 域名。