开放平台

平台规则总览

本页汇总开放平台的通用使用规则。

如果某个接口页没有单独说明,默认适用本页约定。

适用范围

本页适用于当前公开开放的 2.0 API 文档。

后续 3.0 版本如有新增规则,会在对应版本文档中单独说明。

文档中的数据规模、覆盖范围、字段完整度和示例内容,主要用于帮助理解当前版本能力,后续可能会随着数据更新和版本演进而调整。实际接入时,应以当前版本文档和实时接口返回结果为准;如需了解版本差异、兼容原则和文档治理方式,继续阅读 版本与变更策略

调用基本规则

协议与主路径

  • 协议:HTTPS
  • 主路径:https://medical.nocode.com/open/
  • 返回格式:JSON

调用方式

平台基于 HTTP 协议提供接口服务,调用的一般流程为:

  1. 根据接口文档准备参数
  2. 生成签名
  3. 拼装 HTTP 请求
  4. 发起请求并接收响应
  5. 解析 JSON 结果

鉴权与签名规则

所有接口都要求在 Header 中传入以下参数:

参数
是否必填
说明
appid
应用标识
sign
签名结果
timestamp
毫秒级时间戳

签名算法为:

plain.txt
lowercase(MD5(appid + token + timestamp))

额外建议:

  • POST 接口带上 Content-Type: application/json
  • 建议传 X-Request-ID 作为请求追踪 ID

安全规则

开放平台默认适用以下安全约束:

  1. 不建议将 appidtoken 和签名逻辑直接暴露给前端页面
  2. 应通过服务端或受控中间层发起平台请求
  3. 必须使用 HTTPS
  4. 应在本地系统中保留请求日志、错误码和追踪 ID,便于排查

权限与调用范围

平台按 appid 控制调用能力。

这意味着同一个合作方在不同阶段,实际可调用的接口范围和调用量可能不同。

常见受限场景包括:

  • 接口权限未开通
  • 调用来源校验未通过
  • 已超过授权调用量
  • 授权有效期已结束

若收到以下错误码,通常应先确认开通状态,而不是继续调整请求实现:

错误码
英文提示
中文说明
400110
No API permission
当前无接口调用权限
400114
Invalid request source
调用来源校验未通过
400116
Outside authorization validity period
授权未生效或已过期

频率、配额与计费

文档中不会统一写死所有合作方的调用上限和计费规则,因为它们通常和合作范围、接口能力、合同约定直接相关。

但从平台错误码可以看出,以下规则是默认存在的:

错误码
英文提示
中文说明
400112
Daily call quota exceeded
已超过当日调用上限
400113
Request rate limit exceeded
请求过于频繁,请稍后再试
400115
Insufficient balance
账户余额不足

因此在接入时建议同步确认:

  1. 日调用量上限
  2. 峰值频率限制
  3. 是否按接口、调用量或套餐计费
  4. 是否存在授权有效期

若合同或开通说明和本页存在差异,以实际开通结果为准。

响应与错误处理规则

调用失败时,平台通常返回 HTTP 400 和结构化错误对象。
不同接口或历史版本中,message 可能返回英文或中文提示:

example.json
{
  "error": {
    "code": 400108,
    "message": "Invalid request parameters"
  }
}

业务系统接入时,至少应处理以下几类问题:

  • 签名与鉴权错误
  • 参数校验错误
  • 权限与授权错误
  • 频率与配额错误
  • 余额与计费错误
  • 服务端系统错误

数据使用边界

开放平台提供的是数据能力、检索能力和智能算法能力,不同能力对应的业务责任不同。

对于智能分诊、智能问病、推荐用药等智能接口,建议在业务系统中明确其「辅助判断」属性,不应将其作为唯一决策依据。

对于数据类接口,建议在接入时同步确认:

  1. 字段口径是否满足业务场景
  2. 是否需要做本地字段映射
  3. 是否需要结合更新接口做增量同步
  4. 是否存在业务保障机制或人工复核流程

上线建议

正式上线前,建议完成以下检查:

  • 已跑通至少一个最小调用样例
  • 核心接口已完成权限开通
  • 错误码处理逻辑已接入
  • 日志中可定位请求过程
  • 调用量、频率和授权期已确认
  • 关键场景已完成功能验收

如尚未开始联调,建议先阅读 快速开始与接入