API 接口文档 - 民族植物学

概述

本库提供只读的 JSON 接口，供科研机构的程序化访问。接口采用白名单制：每个调用方须持有 API Key，并且只能从登记的 IP 地址或网段访问；受控数据的接口还需要相应的数据集权限（scope）。API Key 与白名单由审核员和系统管理员在后台配置。

申请方式：登录后在“数据服务”提交受控数据申请，并在用途说明中注明需要 API 访问及调用方的固定 IP；或通过“联系我们”与我们联系。

OpenAPI 3: https://ethnobotany.cn/openapi/v1.json

认证

curl -H "X-Api-Key: ebk_XXXXXXXX_..." "https://ethnobotany.cn/api/v1/species?q=qiyeyizhihua"

状态码	含义
200	成功
401	缺少或无效的 API Key，或 Key 已停用、已过期
403	来源 IP 不在该 Key 的白名单内，或缺少接口所需的数据集权限
404	记录不存在
429	超过每分钟调用上限（响应头 Retry-After 给出等待秒数）

每个响应都带有 X-RateLimit-Limit 与 X-RateLimit-Remaining 响应头。

接口列表

接口	所需权限	说明
`GET /api/v1/species?q=&page=&pageSize=`	开放	检索物种（中文名、拼音、拉丁名、异名）
`GET /api/v1/species/{guid}`	开放	物种详情：名称规范化结果、异名、各类关联记录数
`GET /api/v1/species/{guid}/flora`	开放	植物志记载索引（不含正文）
`GET /api/v1/species/{guid}/papers`	开放	相关论文
`GET /api/v1/species/{guid}/formulas`	species_prescriptions	含该物种的古方
`GET /api/v1/species/{guid}/uses`	plant_uses	植物利用记录（功效主治摘要）
`GET /api/v1/formulas?q=&dynasty=`	prescriptions	检索古方（方名或拼音）
`GET /api/v1/formulas/{guid}`	prescriptions	古方详情；组成与编码需 prescription_composition，相似方剂需 prescription_similarity
`GET /api/v1/papers?q=`	开放	检索论文（题名、DOI、PubMed 编号）
`GET /api/v1/names/match?name=`	开放	学名规范化：返回本库物种与接受名
`GET /api/v1/stats`	开放	全库统计

分页参数：page 从 1 开始，pageSize 默认 20、最大 100。分页结果的格式为 {page, pageSize, total, items}。

示例

GET /api/v1/names/match?name=Panax%20pseudoginseng%20var.%20notoginseng
{
  "canonicalName": "Panax pseudoginseng var. notoginseng",
  "matchedVia": "scientific_name",
  "results": [ { "chineseName": "三七", "acceptedName": "Panax notoginseng", "acceptedAuthor": "(Burkill) F.H.Chen",
                 "matchType": "synonym", "wcvpId": "146777", "ipniId": "91521-1", "wfoId": "wfo-0000263666", ... } ]
}

使用接口数据同样须遵守《数据使用协议》并引用本数据库。数据使用协议与伦理声明

地址：中国云南省昆明市蓝黑路132号邮政编码：650201 点击这里联系我们