[B007] 药物搜索的接口地址是什么？

[B007] 药物搜索的接口为 POST https://connect.zhihuiya.com/synapse/drug/search。

[B007] 药物搜索可以返回哪些数据？

[B007] 药物搜索：通过靶点、机构、适应症等字段，获取相关药物。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B007] 药物搜索的 OpenAPI schema？

OpenAPI schema 位于 /openapi.json#/paths/~1synapse~1drug~1search/post，也可在 /openapi.json 浏览完整规范。

[B007] 药物搜索

Q: [B007] 药物搜索 的接口地址是什么？

[B007] 药物搜索 的接口为 POST https://connect.zhihuiya.com/synapse/drug/search。

post

https://connect.zhihuiya.com/synapse/drug/search

在体验中心中试用

通过靶点、机构、适应症等字段，获取相关药物

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`offset`	`integer<int64>`	-	偏移量，默认0
`limit`	`integer<int64>`	`10`	返回条数，默认10。 offset + limit <= 10000， limit最大设置1000
`drug`	`object`	`{ "value": [ "945fa31ebe9e41ae912e493aa3324576" ], "condition": "OR" }`	药物，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "945fa31ebe9e41ae912e493aa3324576" ]`	值列表
`target`	`object`	`{ "value": [ "9786d32e3d244a688ec6a60d2fe1b10b" ], "condition": "OR" }`	靶点，condition默认为OR，支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "9786d32e3d244a688ec6a60d2fe1b10b" ]`	值列表
`disease`	`object`	`{ "value": [ "3beea980d93a4cc0abc864e27514601c" ], "condition": "OR" }`	适应症，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "3beea980d93a4cc0abc864e27514601c" ]`	值列表
`organization`	`object`	`{ "value": [ "6a8c172f1efc649035845f94c31a9c1e" ], "condition": "OR" }`	机构，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "6a8c172f1efc649035845f94c31a9c1e" ]`	值列表
`mechanism_action`	`object`	`{ "value": [ "4dd338b149b3ecd0ee860e1fb379b44f" ], "condition": "OR" }`	作用机制，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "4dd338b149b3ecd0ee860e1fb379b44f" ]`	值列表
`drug_type`	`object`	`{ "value": [ "c38eb408d6b842f487d6a27484156633" ], "condition": "OR" }`	药物类型，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "c38eb408d6b842f487d6a27484156633" ]`	值列表
`global_highest_dev_status`	`array`	`[ "Approved" ]`	最高研发状态。枚举值：Discovery、Preclinical、IND、IND_Approval、Early_Phase_1、Phase_1、Phase_1_2、Phase_2、Phase_2_3、Phase_3、NDA_BLA、Approved、Clinical、Pending、Discontinued、Withdraw、Suspended、Unknown。
`exist_deal`	`boolean`	`true`	是否存在交易
`dev_status`	`array`	`[ "Approved" ]`	研发状态。枚举值：Discovery、Preclinical、IND、IND_Approval、Early_Phase_1、Phase_1、Phase_1_2、Phase_2、Phase_2_3、Phase_3、NDA_BLA、Approved、Clinical、Pending、Discontinued、Withdraw、Suspended、Unknown。
`country`	`array`	`[ "US", "EU" ]`	国家地区。枚举值：US、EU、JP、CN、Other
`organization_type`	`array`	`[ "Company" ]`	机构类型。枚举值：Company、University_Institution、Other
`employee_number`	`array`	`[ "GREATER_THAN_500" ]`	雇员数量。枚举值：LESS_THAN_10、BETWEEN_10_AND_100、BETWEEN_100_AND_500、GREATER_THAN_500
`start_up`	`boolean`	-	是否初创公司
`sort`	`array`	`[ { "sort_field": "DRUG_TYPE_SORT", "sort_order": "desc" }, { "sort_field": "GLOBAL_HIGHEST_DEV_STATUS_RANK", "sort_order": "desc" }, { "sort_field": "FIRST_APPROVED_DATE", "sort_order": "desc" } ]`	字段排序，field支持：DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE；order支持desc, asc（默认desc）
`sort_field`	`string`	`DRUG_TYPE_SORT`	排序字段，枚举值：DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE
`sort_order`	`string`	`desc`	排序方式，支持：desc,asc

请求示例

该 API 接口的请求体示例

JSON

{
  "drug": {
    "value": [
      "945fa31ebe9e41ae912e493aa3324576"
    ],
    "condition": "OR"
  },
  "sort": [
    {
      "sort_field": "DRUG_TYPE_SORT",
      "sort_order": "desc"
    }
  ],
  "limit": 10,
  "offset": 0,
  "target": {
    "value": [
      "9786d32e3d244a688ec6a60d2fe1b10b"
    ],
    "condition": "OR"
  },
  "country": [
    "US",
    "EU"
  ],
  "disease": {
    "value": [
      "3beea980d93a4cc0abc864e27514601c"
    ],
    "condition": "OR"
  },
  "start_up": false,
  "drug_type": {
    "value": [
      "c38eb408d6b842f487d6a27484156633"
    ],
    "condition": "OR"
  },
  "dev_status": [
    "Approved"
  ],
  "exist_deal": true,
  "organization": {
    "value": [
      "6a8c172f1efc649035845f94c31a9c1e"
    ],
    "condition": "OR"
  },
  "employee_number": [
    "GREATER_THAN_500"
  ],
  "mechanism_action": {
    "value": [
      "4dd338b149b3ecd0ee860e1fb379b44f"
    ],
    "condition": "OR"
  },
  "organization_type": [
    "Company"
  ],
  "global_highest_dev_status": [
    "Approved"
  ]
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`object`	-	响应数据
`items`	`array`	`Please check the form:DrugSummaryDto`	查询结果
`drug_id`	`string`	`11d208e0c26a4345946d95f92d9fcaf0`	药物ID
`drug_name`	`array`	`[ { "lang": "CN", "name": "阿达格拉西" }, { "lang": "EN", "name": "Adagrasib" } ]`	药物名称
`lang`	`string`	`EN`	语言
`name`	`string`	`Ranibizumab (Genentech)`	药物、靶点、机构、适应症、国家/地区、字典、作用机制名称
`drug_type`	`array`	`[ { "display_name": [ { "lang": "EN", "name": "Small molecule drug" }, { "lang": "CN", "name": "小分子化药" } ], "normalized_id": "1151dbc710f64a85923dc05d4a5a0ba9" } ]`	药物类型信息
`display_name`	`array`	`[ { "lang": "EN", "name": "Autologous CAR-T" }, { "lang": "CN", "name": "自体CAR-T" } ]`	字典名称
`normalized_id`	`string`	`2fbfdb3e92d942c48cbb0adb79f23526`	字典ID
`limit`	`integer<int64>`	`10`	返回条数
`total`	`integer<int64>`	-	总量
`offset`	`integer<int64>`	-	偏移量
`total_dev_status`	`integer<int64>`	-	涉及的研发状态的数量
`status` 必填	`boolean`	`false`	状态
`error_msg`	`string`	`The request parameter format is incorrect！`	错误信息
`error_code` 必填	`integer`	`0`	错误代码

成功响应示例

成功调用 API 的响应示例

JSON

{
  "data": {
    "items": [
      {
        "drug_id": "11d208e0c26a4345946d95f92d9fcaf0",
        "drug_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ],
        "drug_type": [
          {
            "display_name": [
              {
                "lang": "EN",
                "name": "Ranibizumab (Genentech)"
              }
            ],
            "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
          }
        ]
      }
    ],
    "limit": 10,
    "total": 0,
    "offset": 0,
    "total_dev_status": 0
  },
  "status": true,
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码	描述
`68300004`	请求参数异常!
`68300005`	查询Api失败!
`68300006`	解析基本存取错误!
`68300007`	存在错误的请求!
`68300008`	服务中断异常，请稍后再试!
`68300010`	文件不符合上传规范!

平台错误码

错误码	描述
`67200000`	API整体限流错误!
`67200001`	API整体限流错误！
`67200002`	当前调用速率过快,超过当前配置限制QPS！
`67200003`	申请token的key和secret传参不正确或者客户端已被禁用！
`67200004`	请求的接口无权限请联系我们的支持人员！
`67200005`	账户余额/调用次数不足！
`67200006`	客户端超过开通有效期！
`67200007`	当前调用超过当天配置使用额度！
`67200008`	请检查query参数中必填的apikey是否传输！
`67200009`	apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token！
`67200012`	请求不合法！
`67200100`	当前服务器状态正忙,请求响应超时！
`67200101`	当前请求的Api不存在请检查请求Path！

HTTP 状态码

状态码	描述
`0`	请求成功
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms