Appearance
本文档主要针对 API 开发者,描述疾病识别开放平台接口服务的相关技术内容。
接口能力
| 接口名称 | 接口能力简要描述 |
|---|---|
| 项目列表接口 | 提供指定场景的项目列表 |
| 报告单识别接口 | 对血常规、生化等报告单的识别接口,返回标准化数据解析结果 |
| 疾病识别接口 | 根据报告单项目结果数据进行指定的疾病概率识别,返回疾病风险概率 |
| 结果分析接口 | 对疾病预测数据的图形化展示 |
| 疾病科普接口 | 提供相关疾病的科普知识 |
| 疾病问卷接口 | 提供相关疾病的流调问卷内容 |
| 提交问卷接口 | 根据所提交问卷信息提供疾病综合评估 |
公共信息定义
- 公共请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| Authorization | string | 用于验证请求合法性的认证信息 |
| Version | string | 接口版本号 |
| Timestamp | string | 时间戳(ms),如果请求中的时间和服务器当前时间差 15 分钟以上,服务器将拒绝该请求。 |
- 公共响应体
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 此次请求的请求 id |
| code | int | 响应码 |
| msg | string | 响应码含义 |
| data | object | 响应内容 |
| time | int | 接口响应时间,单位 ms |
访问控制
在 Header 中包含签名
您可以在 HTTP 请求的 Header中增加
Authorization来包含签名(Signature)信息,表明该消息已被授权。
Authorization 字段计算的方法
txt
Authorization = App_key + ":" + Signature
Signature = md5(Version + Timestamp + App_secret)参数说明
| 参数 | 类型 | 是否必选 | 示例值 | 说明 |
|---|---|---|---|---|
| AppKey | string | 是 | G7q29A93**** | 密钥中的 AppKey |
| AppSecret | string | 是 | GUpzG2tc**** | 密钥中的 AppSecret |
| Version | string | 是 | v1 | 请求接口的版本号 |
| Timestamp | string | 是 | 1649297700000 | 时间戳(ms),如果请求中的时间和服务器当前时间差 15 分钟以上,服务器将拒绝该请求。 |
签名示例
假设 App_key 为LTAI4FixJv,App_secret 为Q0YehC6ZyugWfjo,Timestamp 为1649297700000。
Signature = md5(v11649297700000Q0YehC6ZyugWfjo)=145C6FE02731AFA5DC5CCCECF47C8CEA Authorization = LTAI4FixJv:145C6FE02731AFA5DC5CCCECF47C8CEA
- Signature 为 32 位大写字符串
错误码
| 错误码 | 含义 | 备注 |
|---|---|---|
| 401 | 授权类错误 | 检查授权信息,如签名等 |
| 1 | 系统类错误 | 重新发起请求 |
| 3 开头 | 业务类错误 | 根据错误提示进行排查 |