灵析健康开放平台文档
    开放平台相关接口
    • 开放平台相关接口
    • 用户授权对接文档
    • 回调接口说明文档
    • 睡眠数据统计示例demo
    • 获取企业token
      POST
    • 设置回调地址
      POST
    • 查询用户信息
      GET
    • 查询历史数据
      GET
    • 取消用户授权
      DELETE
    • 查询用户授权状态
      GET

      设置回调地址

      POST
      https://cgm-api.lingcgm.com/open/enterprise/callbackUrl
      接口说明
      该接口用于设置企业数据回调地址(Callback URL),并在保存前对回调地址进行有效性校验。只有通过校验的回调地址才会被成功保存,用于后续数据推送。

      1. 校验机制说明(非常重要 ⚠️)#

      在设置回调地址时,我们会向你提供的 url 发起一次 GET 请求进行校验。

      1.1 请求方式#

      GET {callbackUrl}?nonce=xxx&timestamp=xxx&signature=xxx&echoStr=xxx

      1.2 请求参数说明#

      参数名说明
      nonce随机字符串
      timestamp当前时间戳(秒)
      signature签名(见下方算法)
      echoStr随机字符串,用于校验

      2. 签名算法#

      签名生成规则如下:
      1.
      将以下参数放入 Map:
      nonce
      timestamp
      signSecret
      2.
      按参数名排序(字典序)
      3.
      拼接成 URL 参数形式(去掉&和=):
      noncexxxsignSecretxxxtimestampxxx
      4.
      使用 MD5 加密,生成 signature

      3. 你需要实现的逻辑#

      ✅3.1 校验签名(建议做)#

      按相同规则生成 signature,并对比请求中的 signature

      ✅3.2 原样返回 echoStr(必须)#

      4. 校验成功标准#

      我们认为回调地址有效的条件:
      ✅ 返回内容 完全等于 echoStr
      否则:
      ❌ 校验失败,接口返回错误

      5. 失败情况说明#

      以下情况会导致设置失败:
      回调地址不可访问
      请求超时(5秒)
      返回值不等于 echoStr
      接口异常 / 抛错
      签名错误(如果你做了校验)

      请求参数

      Authorization
      在 Header 添加参数
      Authorization
      ,其值为在 Bearer 之后拼接 Token
      示例:
      Authorization: Bearer ********************
      Body 参数application/json必填

      示例
      {
          "url": "string",
          "signSecret": "string"
      }

      请求示例代码

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      请求示例请求示例
      Shell
      JavaScript
      Java
      Swift
      curl --location 'https://cgm-api.lingcgm.com/open/enterprise/callbackUrl' \
      --header 'Authorization: Bearer <token>' \
      --header 'Content-Type: application/json' \
      --data '{
          "url": "string",
          "signSecret": "string"
      }'

      返回响应

      🟢200成功
      application/json
      Bodyapplication/json

      示例
      按照接口说明设置回调地址,保证get校验接口能公网访问
      {
          "timestamp": 1774255546,
          "code": 4001,
          "message": "回调地址校验失败",
          "data": null,
          "errorData": null
      }
      修改于 2026-07-16 03:50:36
      上一页
      获取企业token
      下一页
      查询用户信息
      Built with