接口描述
本接口用于获取知识库中的中药数据。
- 请求地址:
https://openapi.macrocura.com/knowledge/medicines/
- 请求方法:
GET
API
版本要求
- 详见版本发布
请求示例
GET https://openapi.macrocura.com/knowledge/medicines/
请求参数
无
响应示例
{
"code": 2000,
"description": "success",
"results": [
{
"uuid": "830c8231-baa9-43ce-804d-8bfaa72155a3",
"name": "阿胶",
"alias_list": ["阿胶", "驴皮阿胶", "驴皮胶"],
"similar_list": [],
"dosage_normal": "6",
"dosage_upper": "20",
"dosage_lower": "1",
"is_toxic": false,
"pinyin": "aj",
"usage_level": 2
},
...
]
}
公共响应参数
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
code | Number | 请求处理的状态码 | 2000 |
description | String | 请求处理的状态描述 | "success" |
results | Object | 请求处理的返回值,具体内容参照各章节"返回数据说明" | {} 或 [] |
返回数据说明
results
字段为本接口返回的中药数据,它的构成如下:
名称 | 类型 | 描述 |
---|---|---|
uuid | String | 中药的uuid |
name | String | 中药的名称 |
alias_list | Array | 中药别名列表 |
similar_list | Array | 相似中药列表 |
dosage_normal | String | 标准用量 |
dosage_upper | String | 最大用量 |
dosage_lower | String | 最小用量 |
is_toxic | Boolean | 是否有毒 |
pinyin | String | 中药的中文拼音 |
usage_level | Number | 中药常用程度等级 |
- 根据脉景开放平台的建议,某一中药的相似中药数据存放于
similar_list
字段。 usage_level
字段代表某一中药的常用程度等级,用户可以参考此数据进行药品备货,等级划分为:- 等级
3
:强烈建议备货 - 等级
2
:建议备货 - 等级
1
:根据实际情况备货
- 等级