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

药物搜索：药物检索。完整响应结构请参见本页的响应结构与成功响应示例。

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

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

药物搜索

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

药物搜索 的接口为 POST https://stage-connect.zhihuiya.com/api-ls/ls/v2/drug/search。

post

https://stage-connect.zhihuiya.com/api-ls/ls/v2/drug/search

在体验中心中试用

药物检索

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`offset`	`integer`	-	分页偏移量
`limit`	`integer`	`20`	分页大小
`drug`	`array`	`[ "pembrolizumab" ]`	药物名称列表
`target`	`array`	`[ "PD-1" ]`	靶点名称列表
`disease`	`array`	`[ "non-small cell lung cancer" ]`	疾病名称列表
`organization`	`array`	`[ "Merck" ]`	组织名称列表
`drug_type`	`array`	`[ "Monoclonal antibody" ]`	药物类型列表
`action_type`	`array`	`[ "inhibitor" ]`	作用类型列表
`mechanism_action`	`array`	`[ "PD-1 inhibitor" ]`	作用机制列表
`atc_code`	`array`	`[ "L01" ]`	ATC 编码列表
`modification`	`array`	`[ "PEGylated" ]`	化学修饰列表
`highest_phase`	`array`	`[ "approved" ]`	全球最高研发阶段列表
`dev_status`	`array`	`[ "phase_3" ]`	当前研发状态列表
`org_type`	`array`	`[ "company" ]`	组织类型列表
`highest_phase_date_from`	`string`	`2023-01-01`	最高研发阶段起始日期
`highest_phase_date_to`	`string`	`2024-12-31`	最高研发阶段结束日期
`country`	`array`	`[ "US", "CN" ]`	国家或地区代码列表

{
  "drug": [
    "pembrolizumab"
  ],
  "limit": 20,
  "offset": 0,
  "target": [
    "PD-1"
  ],
  "country": [
    "US",
    "CN"
  ],
  "disease": [
    "non-small cell lung cancer"
  ],
  "atc_code": [
    "L01"
  ],
  "org_type": [
    "company"
  ],
  "drug_type": [
    "Monoclonal antibody"
  ],
  "dev_status": [
    "phase_3"
  ],
  "action_type": [
    "inhibitor"
  ],
  "modification": [
    "PEGylated"
  ],
  "organization": [
    "Merck"
  ],
  "highest_phase": [
    "approved"
  ],
  "mechanism_action": [
    "PD-1 inhibitor"
  ],
  "highest_phase_date_to": "2024-12-31",
  "highest_phase_date_from": "2023-01-01"
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`items`	`array`	[ { "drug_id": "DRUG-000001", "reference": "drug:DRUG-000001", "drug_type_view": [ { "id": "ENTITY-000001", "entity_id": "ENTITY-000001", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab" } ], "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "first_approved_date": "2014-09-04", "global_highest_dev_status_view": { "id": "ENTITY-000001", "entity_id": "ENTITY-000001", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab" } } ]	结果记录列表
`drug_id`	`string`	`DRUG-000001`	药物 ID
`reference`	`string`	`drug:DRUG-000001`	稳定引用标识
`drug_type_view`	`array`	`[ { "id": "ENTITY-000001", "entity_id": "ENTITY-000001", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab" } ]`	字段 drug_type_view
`id`	`string`	`ENTITY-000001`	实体 ID
`entity_id`	`string`	`ENTITY-000001`	组织实体 ID
`display_name_cn`	`string`	`帕博利珠单抗`	中文显示名称
`display_name_en`	`string`	`Pembrolizumab`	英文显示名称
`display_name_cn`	`string`	`帕博利珠单抗`	中文显示名称
`display_name_en`	`string`	`Pembrolizumab`	英文显示名称
`first_approved_date`	`string`	`2014-09-04`	字段 first_approved_date
`global_highest_dev_status_view`	`object`	`{ "id": "ENTITY-000001", "entity_id": "ENTITY-000001", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab" }`	字段 global_highest_dev_status_view
`query`	`object`	{ "sort": [ { "sort_field": "example", "sort_order": "example" } ], "stem": false, "limit": 20, "query": { "must": [ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ], "type": "example", "should": [ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ], "must_not": [ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ] }, "fields": [ "example" ], "offset": 0, "all_org": false, "collapse": { "field": "example", "rules": [ { "type": "example", "field": "example" } ] }, "field_list": [ "example" ], "load_detail": false, "search_type": "example", "semantic_search": false }	自然语言检索语句
`sort`	`array`	`[ { "sort_field": "example", "sort_order": "example" } ]`	字段 sort
`sort_field`	`string`	`example`	排序字段
`sort_order`	`string`	`example`	字段 sort_order
`stem`	`boolean`	-	字段 stem
`limit`	`integer`	`20`	分页大小
`query`	`object`	{ "must": [ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ], "type": "example", "should": [ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ], "must_not": [ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ] }	自然语言检索语句
`must`	`array`	`[ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ]`	字段 must
`type`	`string`	`example`	检索类型
`value`	`array`	`[ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ]`	字段 value
`id`	`string`	`ENTITY-000001`	实体 ID
`type`	`string`	`example`	检索类型
`display_name_cn`	`string`	`帕博利珠单抗`	中文显示名称
`display_name_en`	`string`	`Pembrolizumab`	英文显示名称
`search_strategy`	`string`	`example`	字段 search_strategy
`fields`	`array`	`[ "example" ]`	字段 fields
`condition`	`string`	`example`	字段 condition
`type`	`string`	`example`	检索类型
`should`	`array`	`[ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ]`	字段 should
`must_not`	`array`	`[ { "type": "example", "value": [ { "id": "ENTITY-000001", "type": "example", "display_name_cn": "帕博利珠单抗", "display_name_en": "Pembrolizumab", "search_strategy": "example" } ], "fields": [ "example" ], "condition": "example" } ]`	字段 must_not
`fields`	`array`	`[ "example" ]`	字段 fields
`offset`	`integer`	-	分页偏移量
`all_org`	`boolean`	-	字段 all_org
`collapse`	`object`	`{ "field": "example", "rules": [ { "type": "example", "field": "example" } ] }`	字段 collapse
`field`	`string`	`example`	字段 field
`rules`	`array`	`[ { "type": "example", "field": "example" } ]`	字段 rules
`type`	`string`	`example`	检索类型
`field`	`string`	`example`	字段 field
`field_list`	`array`	`[ "example" ]`	字段 field_list
`load_detail`	`boolean`	-	字段 load_detail
`search_type`	`string`	`example`	字段 search_type
`semantic_search`	`boolean`	-	字段 semantic_search
`total`	`integer`	-	总记录数
`warnings`	`array`	`[ "example" ]`	查询警告信息

成功响应示例

成功调用 API 的响应示例

JSON

{
  "items": [
    {
      "drug_id": "DRUG-000001",
      "reference": "drug:DRUG-000001",
      "drug_type_view": [
        {
          "id": "ENTITY-000001",
          "entity_id": "ENTITY-000001",
          "display_name_cn": "帕博利珠单抗",
          "display_name_en": "Pembrolizumab"
        }
      ],
      "display_name_cn": "帕博利珠单抗",
      "display_name_en": "Pembrolizumab",
      "first_approved_date": "2014-09-04",
      "global_highest_dev_status_view": {
        "id": "ENTITY-000001",
        "entity_id": "ENTITY-000001",
        "display_name_cn": "帕博利珠单抗",
        "display_name_en": "Pembrolizumab"
      }
    }
  ],
  "query": {
    "sort": [
      {
        "sort_field": "example",
        "sort_order": "example"
      }
    ],
    "stem": false,
    "limit": 20,
    "query": {
      "must": [
        {
          "type": "example",
          "value": [
            {
              "id": "ENTITY-000001",
              "type": "example",
              "display_name_cn": "帕博利珠单抗",
              "display_name_en": "Pembrolizumab",
              "search_strategy": "example"
            }
          ],
          "fields": [
            "example"
          ],
          "condition": "example"
        }
      ],
      "type": "example",
      "should": [
        {
          "type": "example",
          "value": [
            {
              "id": "ENTITY-000001",
              "type": "example",
              "display_name_cn": "帕博利珠单抗",
              "display_name_en": "Pembrolizumab",
              "search_strategy": "example"
            }
          ],
          "fields": [
            "example"
          ],
          "condition": "example"
        }
      ],
      "must_not": [
        {
          "type": "example",
          "value": [
            {
              "id": "ENTITY-000001",
              "type": "example",
              "display_name_cn": "帕博利珠单抗",
              "display_name_en": "Pembrolizumab",
              "search_strategy": "example"
            }
          ],
          "fields": [
            "example"
          ],
          "condition": "example"
        }
      ]
    },
    "fields": [
      "example"
    ],
    "offset": 0,
    "all_org": false,
    "collapse": {
      "field": "example",
      "rules": [
        {
          "type": "example",
          "field": "example"
        }
      ]
    },
    "field_list": [
      "example"
    ],
    "load_detail": false,
    "search_type": "example",
    "semantic_search": false
  },
  "total": 0,
  "status": true,
  "warnings": [
    "example"
  ],
  "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`	请求成功
`400`	参数错误
`422`	请求参数校验失败

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms