Interface: 技术描述^2022/12/7

技术描述^2022/12/7

  1. 获取appId（partnerId）和secret
    1. 访问：辨证云®中医AI零代码开发平台 通过邮箱注册并登录
    2. 在 基本设置 点击 去认证 等待平台认证成功后，再点击 生成
    3. 密钥生成后，点击 发送到邮箱，平台会将会向注册邮箱发送appId和secret
  2. 接口基础地址
    1. 生产环境：https://c.zydsoft.cn/open/api
    2. 沙箱环境：https://t.zydsoft.cn/open/api（沙箱环境仅提供典型性数据供开发调试）
  3. 编码格式
      4. UTF-8
  4. 沙箱调试
    1. 生产环境：https://c.zydsoft.cn/open/sandBox
    2. 沙箱环境：https://t.zydsoft.cn/open/sandBox
  5. 接口通信方式
    1. 通信流程
    2. 通信步骤
      1. 请求方根据服务端提供的 URL 以 HTTP POST 或 GET 方式提交请求，服务端接到请求后处理请求，以 JSON 格式的形式返回处理结果
      2. 请求方接收服务端 JSON 格式的回复报文，并对该报文进行解析
      3. 调用结束
  6. 接口的调用
    1. 先请求 获取token 接口，获取token，建议将获取的token缓存使用，token默认有效期7200秒
    2. 所有业务接口请求必须包含 token 信息，将获取到的 token 字符前面拼接 Bearer 字符，Bearer 与 token 中间用空格分隔，将拼接后的字符写入 Request Headers 中的 Authorization 属性
    3. 所有业务接请求用都需要具备 签名 和时间戳参数，参数名：sign、timestamp，所有入参均需要包含时间戳，参数名：timestamp，值为秒值，长度10位，时间戳有效期：±10分钟
  7. IP 地址白名单
    1. 获取token 接口，请使用服务器端发起请求
    2. 需要请求方登录辨证云®中医AI零代码开发平台设置 IP 地址白名单（最多 30 个），添加白名单后才能成功请求 获取token 接口
  8. error 的 throws
    1. 所有错误代码抛出均通过 HTTP.StatusCode 方式返回
    2. 请求成功时 HTTP.StatusCode 返回值为 200
    3. 错误描述采用JSON格式返回，示例：{"code":412,"message":"err info"}
Since:
  • 2022/12/7
Author:
  • zz