[B065] 抗原-抗体配对检索的接口地址是什么？

[B065] 抗原-抗体配对检索的接口为 GET https://connect.zhihuiya.com/synapse/bio/antibody/search。

[B065] 抗原-抗体配对检索可以返回哪些数据？

[B065] 抗原-抗体配对检索：通过抗原名称搜索相关抗体序列信息，包括抗原序列、抗体重链/轻链序列、UniProt ID、来源等信息。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B065] 抗原-抗体配对检索的 OpenAPI schema？

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

[B065] 抗原-抗体配对检索

Q: [B065] 抗原-抗体配对检索 的接口地址是什么？

[B065] 抗原-抗体配对检索 的接口为 GET https://connect.zhihuiya.com/synapse/bio/antibody/search。

get

https://connect.zhihuiya.com/synapse/bio/antibody/search

在体验中心中试用

通过抗原名称搜索相关抗体序列信息，包括抗原序列、抗体重链/轻链序列、UniProt ID、来源等信息

antigen_name 为必填参数，page必须>=1，rows必须>=1且<=10

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`antigen_name` 必填	`string`	`TRBV6-2`	抗原名称
`page`	`integer<int32>`	`1`	页码（必须>=1）
`rows`	`integer<int32>`	`10`	每页条数（必须>=1且<=10）

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`object`	-	响应数据
`page`	`integer<int32>`	`1`	当前页码
`rows`	`integer<int32>`	`10`	每页条数
`items`	`array`	`Please check the form: AntibodyDetail`	查询结果
`source`	`object`	`Please check the form: AntibodyPatentInfo`	来源信息
`source_type`	`string`	`patent`	数据来源类型
`antibody_patent_id`	`string`	`AB_12345678`	抗体专利ID
`antibody_patent_number`	`string`	`CN302052315S`	专利公开号
`heavy_chain_sequence_id`	`string`	`HC_12345678`	智慧芽内部重链序列编码
`light_chain_sequence_id`	`string`	`LC_12345678`	智慧芽内部轻链序列编码
`affinity_id`	`string`	`n14778540229713683257531356477449681766`	亲和力查询ID
`antigen_name`	`string`	`CD19`	抗原名称
`antibody_name`	`array`	`[ "Rituximab" ]`	抗体名称列表
`antigen_species`	`string`	`Human`	抗原物种
`antigen_uniport`	`array`	`Please check the form: AntibodyUniport`	抗原UniProt列表
`uniprot_id`	`string`	`P15391`	抗原uniprot ID
`uniprot_id_seq`	`string`	`MKLLVVVLFLGAETTGSTQQLIQESGPGLVAPSQSLSITCTVSGFSLTNYGVHWVRQSPGKGLEWLGVIWSGGNTDYNTPFTSRLSINKDNSKSQVFFKMNSLQSNDTAIYYCARDYRYDYWGQGTLVTVSS`	抗原uniprot ID序列
`antigen_sequence`	`string`	`MKLLVVVLFLGAETTGSTQQLIQESGPGLVAPSQSLSITCTVSGFSLTNYGVHWVRQSPGKGLEWLGVIWSGGNTDYNTPFTSRLSINKDNSKSQVFFKMNSLQSNDTAIYYCARDYRYDYWGQGTLVTVSS`	抗原序列
`antibody_sequence`	`object`	`Please check the form: AntibodySequenceInfo`	抗体序列信息
`antibody_heavy_chain`	`string`	`EVQLVESGGGLVQPGGSLRLSCAASGFTFSSYAMSWVRQAPGKGLEWVSAISGSGGSTYYADSVKGRFTISRDNSKNTLYLQMNSLRAEDTAVYYCARDYRYDYWGQGTLVTVSS`	抗体重链序列
`antibody_light_chain`	`string`	`DIQMTQSPSSLSASVGDRVTITCRASQDVNTAVAWYQQKPGKAPKLLIYSASFLYSGVPSRFSGSRSGTDFTLTISSLQPEDFATYYCQQHYTTPPTFGQGTKVEIK`	抗体轻链序列
`heavy_chain_sequence_number`	`integer<int64>`	`123456789`	重链序列编号
`light_chain_sequence_number`	`integer<int64>`	`987654321`	轻链序列编号
`total`	`integer<int64>`	`100`	总量
`status` 必填	`boolean`	`false`	状态
`error_msg`	`string`	`The request parameter format is incorrect！`	错误信息
`error_code` 必填	`integer`	`0`	错误代码

成功响应示例

成功调用 API 的响应示例

JSON

{
  "data": {
    "page": 1,
    "rows": 10,
    "items": [
      {
        "source": {
          "source_type": "patent",
          "antibody_patent_id": "AB_12345678",
          "antibody_patent_number": "CN302052315S",
          "heavy_chain_sequence_id": "HC_12345678",
          "light_chain_sequence_id": "LC_12345678"
        },
        "affinity_id": "n14778540229713683257531356477449681766",
        "antigen_name": "CD19",
        "antibody_name": [
          "Rituximab"
        ],
        "antigen_species": "Human",
        "antigen_uniport": [
          {
            "uniprot_id": "P15391",
            "uniprot_id_seq": "MKLLVVVLFLGAETTGSTQQLIQESGPGLVAPSQSLSITCTVSGFSLTNYGVHWVRQSPGKGLEWLGVIWSGGNTDYNTPFTSRLSINKDNSKSQVFFKMNSLQSNDTAIYYCARDYRYDYWGQGTLVTVSS"
          }
        ],
        "antigen_sequence": "MKLLVVVLFLGAETTGSTQQLIQESGPGLVAPSQSLSITCTVSGFSLTNYGVHWVRQSPGKGLEWLGVIWSGGNTDYNTPFTSRLSINKDNSKSQVFFKMNSLQSNDTAIYYCARDYRYDYWGQGTLVTVSS",
        "antibody_sequence": {
          "antibody_heavy_chain": "EVQLVESGGGLVQPGGSLRLSCAASGFTFSSYAMSWVRQAPGKGLEWVSAISGSGGSTYYADSVKGRFTISRDNSKNTLYLQMNSLRAEDTAVYYCARDYRYDYWGQGTLVTVSS",
          "antibody_light_chain": "DIQMTQSPSSLSASVGDRVTITCRASQDVNTAVAWYQQKPGKAPKLLIYSASFLYSGVPSRFSGSRSGTDFTLTISSLQPEDFATYYCQQHYTTPPTFGQGTKVEIK",
          "heavy_chain_sequence_number": 123456789,
          "light_chain_sequence_number": 987654321
        }
      }
    ],
    "total": 100
  },
  "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`	请求成功
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms