开放接口接入前准备

开始调用接口之前

开放接口以您上传的应用为身份主体。正式开发前,请先准备该应用的 APPID、UID、包名和 API Key,并在客户端生成稳定且非空的设备标识 DID。

需要准备什么

应用身份 APPID、UID、应用包名
访问凭证 该应用独立的 API Key
设备标识 客户端生成的非空 DID

开通与获取参数

  1. 登录云注入并上传安装包

    进入“应用管理”中的“我的应用”,点击“上传要注入的APP”并选择安装包。 安装包上传和解析完成后,系统会创建一条应用记录。

    应用管理 我的应用 上传要注入的APP
  2. 确认 APPID、UID 和包名

    在“我的应用”列表中找到刚上传的目标应用。列表的 ID 就是该应用的 appidUID 就是应用所属用户的 uid, “包名”列就是请求中的 package。请使用同一行记录中的数据。

  3. 进入应用编辑窗口

    点击目标应用右侧的“编辑”按钮。编辑窗口会再次显示 APPID、包名以及 API Key 管理区域,便于核对当前操作的应用。

    目标应用 编辑 API Key
  4. 生成并复制 API Key

    如果 API Key 为空,表示该应用尚未开启外部 API 访问权限。点击 “生成 API Key”,等待安全确认倒计时结束后确认操作;生成成功后点击 “复制 Key”并妥善保存。每个应用的 Key 独立,不可跨应用使用。

  5. 在客户端准备 DID

    did 是调用接口的设备唯一标识,需要由客户端自行获取或生成。 它必须为非空字符串,并应在同一台设备上保持稳定。卡密绑定、试用和解绑等 业务都会使用 DID 判断设备身份。

如果应用采用配置复用或发生映射,请仍然提交当前请求所属“原始应用”记录的 APPID、UID、包名和 API Key,不要改为被复用或映射后应用的身份参数。

公共身份参数说明

请求参数 是否必填 获取位置 用途与注意事项
appid 必填 “我的应用”列表的 ID,编辑窗口也会显示 应用记录的唯一编号,是服务端进行应用身份校验的基准。
uid 必填 “我的应用”列表的 UID 应用所属用户的账号 ID,必须与 APPID 对应应用的归属一致。
package 必填 “我的应用”列表或编辑窗口中的包名 安装包的应用包名,必须与 APPID 对应记录中的包名完全一致。
key 必填 目标应用“编辑”窗口的 API Key 区域 接口访问和响应验签的共享密钥;Key 为空时,该应用不能访问外部接口。
did 必填 由接入方客户端自行获取或生成 设备唯一标识,不能为空,并应确保同一设备上的值长期稳定。
接口会联合校验 appiduidpackagekey。其中任何一项不属于同一应用,都会返回应用身份校验失败。

API Key 管理须知

操作 结果 适用场景
生成 API Key 为当前应用开通外部 API 访问权限 首次接入开放接口
复制 Key 复制当前有效的明文 Key 配置客户端请求及响应验签
重置 API Key 生成新 Key,旧 Key 立即失效 Key 泄露或需要轮换访问凭证
清空 API Key 关闭当前应用的外部 API 访问权限 暂停或终止接口接入
API Key 属于敏感凭证。请只通过 HTTPS 调用接口,不要在公开仓库、日志、 截图或可直接读取的前端页面中暴露。重置或清空后,请及时同步更新客户端配置。

调用前检查清单

准备完成后,请返回文档中心选择具体接口。每份接口文档都包含请求参数、 完整响应结构、签名算法和多语言调用示例。

选择接口文档 →