设备指纹
使用控制台快速开始

创建第一个接入端

快速开始: 创建第一个接入端

接入端代表应用中的具体 Web、iOS 或 Android 接入实例。创建后,系统会为接入端生成独立的 Public API Key。

打开创建接入端弹窗

可以通过以下任一入口创建:

  • 在应用创建成功提示中点击 创建第一个接入端
  • 进入 应用管理 → 应用详情 → 接入端,点击 新建接入端

控制台、接口、提示文案和文档应统一使用“接入端(Endpoint)”。如果当前版本仍显示“场景节点”,二者在本指南中表示同一对象。

填写基础信息

填写接入端名称和描述,并选择平台。

建议名称同时包含业务入口和平台,例如:

结账页 Web
商城客户端 iOS
商城客户端 Android

平台创建后是否允许修改,应以当前控制台为准。为了避免 Public API Key、安全配置和统计归属混乱,建议将平台视为固定属性。

配置 Web 接入端

选择 Web 后,配置允许访问的来源。

Allowed Origins

Origin 通常由协议、域名和端口组成,不包含页面路径。

有效示例:

https://www.example.com
https://checkout.example.com
https://staging.example.com:8443

不要只填写 example.com。是否允许通配符以及本地开发地址,以控制台当前校验规则为准。

Allowed Referers

如果产品支持 Referer 校验,可以进一步限制允许调用 SDK 的页面路径。路径和通配符格式应按照字段提示填写。

示例:

https://checkout.example.com/*
https://*.example.com/pay/*

正式接入时,应使用尽可能精确的来源范围,避免将不受控制的域名加入白名单。

图示:Web 接入端安全配置

配置 iOS 接入端

选择 iOS 后,可以启用应用签名校验。

启用后,按照控制台要求填写 Bundle ID,例如:

com.company.app

Bundle ID 应与实际构建和发布的应用完全一致。配置错误可能导致合法客户端请求被拒绝。

测试版和正式版如果使用不同 Bundle ID,应分别规划接入端或配置相应允许规则。

图示:iOS 应用签名校验

配置 Android 接入端

选择 Android 后,可以启用应用签名校验。

启用后,按照控制台要求填写:

  • Package Name,例如 com.company.app
  • App Signature,即实际发布应用使用的签名信息。

Package Name 和 App Signature 必须与实际安装包一致。Debug、测试和正式版本如果使用不同签名,应提前设计测试与生产接入方式。

图示:Android 应用签名校验

设置初始限流

接入端可以设置每分钟和每小时请求上限,用于减少 Public API Key 被盗用或异常流量消耗配额的风险。

首次配置时,可以参考业务正常峰值设置,并预留合理余量:

建议初始阈值 = 近期正常峰值 × 1.5 至 2

以上仅是规划方法,不是适用于所有业务的固定数值。高峰明显的营销、票务或支付业务,应结合容量评估设置。

配置时注意:

  • 每分钟限制乘以 60 不应高于每小时限制。
  • 留空是否表示不启用接入端级限制,以页面说明为准。
  • 即使不配置接入端限流,请求仍可能受应用级限制、组织配额和订阅状态影响。
  • 超限后,GEELAB 可能拒绝本次请求;进入下一时间窗口后自动恢复。

创建并获取 Public API Key

完成配置后点击 创建接入端。创建成功后,系统生成该接入端的 Public API Key。

在接入端列表或详情中点击复制按钮,复制完整 Public API Key。复制后:

  1. 将密钥提供给负责客户端接入的研发人员。
  2. 仅用于当前接入端对应的平台。
  3. 不要用它调用服务端 API。
  4. 不要移除已配置的来源校验、应用签名校验或限流。

Public API Key 是公开客户端密钥,出现在客户端代码中是正常的;安全性主要依赖来源校验、应用签名校验、限流和后台风控。它与必须保密的 Region 服务端密钥不同。

图示:接入端详情与 Public API Key