首页 / 文档 / 凭证与开放 API

凭证与开放 API

当需要把平台数据接进客户自己的系统时,用凭证 + OpenAPI 完成对接。凭证决定"能取哪些数据",密钥只存哈希、只展示一次,随时可以撤销。

共 4 个小节 · 文档随平台版本更新

创建一张凭证

吉物 AIoT 平台 · [object Object] 界面示意
产品管理设备管理数据大屏AI 助理凭证管理
凭证管理 + 新建凭证
凭证名称AppKey绑定产品状态ERP 对接-生产环境AK7f3d…9c21空压机 A 型 等 3 个● 启用客户门户-演示AK2b8e…4d77冷库温控器● 启用
AppSecretsk-••••••••••••••••(仅创建时显示一次)②立即复制保存可见产品范围空压机 A 型 · 冷库温控器③按最小必要授权

密钥在服务端以哈希存储,列表永不回显;凭证可随时撤销,撤销后立即失效。

[object Object]
  1. 1[object Object]
  2. 2[object Object]
  3. 3[object Object]
  1. 进入「凭证管理」,点击新建。
  2. 填写凭证名称,建议写清用途与使用方(例如"ERP 对接-生产环境")。
  3. 绑定凭证可见的产品范围,只勾选真正需要的数据。
  4. 保存后立即复制 AppKey 与 AppSecret:AppSecret 只在创建时明文展示一次。
  5. 把密钥交给对接方,通过安全渠道传递,不要写在工单或聊天记录里。

注意AppSecret 在服务端以 BCrypt 哈希存储,平台不提供再次查看。忘了只能重新生成。

调用接口

每个请求携带两个请求头完成身份校验:

  • X-App-Key:凭证的 AppKey。
  • X-App-Secret:凭证的 AppSecret。
  • 产品列表:查询凭证范围内的产品,支持名称、类别、行业过滤。
  • 设备列表:查询指定产品下的设备,支持名称与状态过滤。
  • 设备数据:查询指定设备的时序数据,支持时间范围与条数限制。

注意开放接口的认证体系与用户登录完全隔离:凭证泄露不会影响平台内的账号安全,反之平台账号也无法调用开放接口。

大屏里的凭证

  • 数据大屏通过画布级凭证取数,用的是同一套凭证体系。
  • 大屏只保存凭证 ID,不保存密钥;取数由后端代理完成。
  • 因此大屏 JSON 即使被导出,也不会泄露密钥。

安全与维护

  • 一个使用方一张凭证,不要多人共用,出问题时好定位也好撤销。
  • 人员变动或对接结束时,直接撤销对应凭证,权限立即失效。
  • 产品范围按最小必要授权,不要图省事全选。
  • 定期核对凭证清单,清理长期未使用的凭证。