认证
公开站点默认匿名访问；第三方调用方可按需在请求头中携带 X-API-Key。
阅览 API 指南
这里集中整理了公开站点实际使用的 `open-api` 能力，包含搜索、详情、关联、ISBN、统计与健康检查接口。
站点真实契约公共访问
访问约束
搜索、详情、关联、ISBN 与统计接口都集中在同一页，便于对照参数与返回结构。
统一响应
所有接口都返回统一 envelope，页面展示的字段说明只描述 `data` 结构。
codenumber
业务状态码，成功时为 200
messagestring
响应消息
dataobject
接口实际返回数据
timestampnumber
服务端响应时间戳
pathstring
命中的接口路径
请求示例
以下示例直接对应当前站点使用的搜索接口。
curl -G "https://open-api.iyuelan.cn/search/query" \ --data-urlencode "keyword=三体" \ --data-urlencode "type=book" \ --data-urlencode "page=1" \ --data-urlencode "pageSize=20"
- 所有接口都返回统一 envelope，页面展示的 response fields 只描述 data 字段。
- 公开站点默认匿名访问；第三方调用方可按需在请求头中携带 X-API-Key。
- 搜索、详情、关联、ISBN 与统计接口都集中在同一页，便于快速对照和联调。
通用搜索
1 个 GET 端点
GET/search/query
通用关键词检索（图书/作者/出版社/丛书）
SearchResponse data
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| keyword | string | 搜索关键词 | query |
| type | all | book | author | publisher | series | 实体类型过滤 | query |
| page | number | 页码（>=1） | query |
| pageSize | number | 每页数量（1-50） | query |
keywordstringrequired
原始搜索关键词
typeall | book | author | publisher | seriesrequired
当前搜索类型
pagenumberrequired
当前页码
pageSizenumberrequired
每页数量
totalnumberrequired
总命中数
totalPagesnumberrequired
总页数
itemsEntityResponseItemDto[]required
结构化实体列表，每项包含 entity_type、entity_id、entity
实体查询
7 个 GET 端点
GET/entities/{entityType}/{entityId}
按实体类型和实体 ID 查询详情
EntityResponseItemDto
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| entityType | book | author | publisher | series | 实体类型 | path |
| entityId | string | 实体 ID | path |
entity_typebook | author | publisher | seriesrequired
实体类型
entity_idstringrequired
实体 ID
entityRecord<string, unknown>required
结构化实体详情，按 entity_type 返回图书/作者/出版社/丛书对应字段
GET/entities/book/{entityId}/authors
查询图书关联作者列表
RelatedEntityListResponseDto
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| entityId | string | 图书 ID | path |
| page | number | 页码 | query |
| pageSize | number | 每页数量 | query |
entity_typebook | author | publisher | seriesrequired
主实体类型
related_typebook | author | publisher | seriesrequired
关联实体类型
pagenumberrequired
当前页码
pageSizenumberrequired
每页数量
totalnumberrequired
总条数
totalPagesnumberrequired
总页数
itemsRecord<string, unknown>[]required
关联实体列表，元素字段取决于 related_type
GET/entities/book/{entityId}/publishers
查询图书关联出版社列表
RelatedEntityListResponseDto
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| entityId | string | 图书 ID | path |
| page | number | 页码 | query |
| pageSize | number | 每页数量 | query |
entity_typebook | author | publisher | seriesrequired
主实体类型
related_typebook | author | publisher | seriesrequired
关联实体类型
pagenumberrequired
当前页码
pageSizenumberrequired
每页数量
totalnumberrequired
总条数
totalPagesnumberrequired
总页数
itemsRecord<string, unknown>[]required
关联实体列表，元素字段取决于 related_type
GET/entities/book/{entityId}/series
查询图书关联丛书列表
RelatedEntityListResponseDto
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| entityId | string | 图书 ID | path |
| page | number | 页码 | query |
| pageSize | number | 每页数量 | query |
entity_typebook | author | publisher | seriesrequired
主实体类型
related_typebook | author | publisher | seriesrequired
关联实体类型
pagenumberrequired
当前页码
pageSizenumberrequired
每页数量
totalnumberrequired
总条数
totalPagesnumberrequired
总页数
itemsRecord<string, unknown>[]required
关联实体列表，元素字段取决于 related_type
GET/entities/author/{entityId}/books
查询作者关联图书列表
RelatedEntityListResponseDto
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| entityId | string | 作者 ID | path |
| page | number | 页码 | query |
| pageSize | number | 每页数量 | query |
entity_typebook | author | publisher | seriesrequired
主实体类型
related_typebook | author | publisher | seriesrequired
关联实体类型
pagenumberrequired
当前页码
pageSizenumberrequired
每页数量
totalnumberrequired
总条数
totalPagesnumberrequired
总页数
itemsRecord<string, unknown>[]required
关联实体列表，元素字段取决于 related_type
GET/entities/publisher/{entityId}/books
查询出版社关联图书列表
RelatedEntityListResponseDto
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| entityId | string | 出版社 ID | path |
| page | number | 页码 | query |
| pageSize | number | 每页数量 | query |
entity_typebook | author | publisher | seriesrequired
主实体类型
related_typebook | author | publisher | seriesrequired
关联实体类型
pagenumberrequired
当前页码
pageSizenumberrequired
每页数量
totalnumberrequired
总条数
totalPagesnumberrequired
总页数
itemsRecord<string, unknown>[]required
关联实体列表，元素字段取决于 related_type
GET/entities/series/{entityId}/books
查询丛书关联图书列表
RelatedEntityListResponseDto
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| entityId | string | 丛书 ID | path |
| page | number | 页码 | query |
| pageSize | number | 每页数量 | query |
entity_typebook | author | publisher | seriesrequired
主实体类型
related_typebook | author | publisher | seriesrequired
关联实体类型
pagenumberrequired
当前页码
pageSizenumberrequired
每页数量
totalnumberrequired
总条数
totalPagesnumberrequired
总页数
itemsRecord<string, unknown>[]required
关联实体列表，元素字段取决于 related_type
ISBN 查询
1 个 GET 端点
GET/isbn/query
通过 ISBN 查询图书详情（三方）
BookDetailDto
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| isbn | string | ISBN 号码 | query |
idstringrequired
图书 ID
isbnstring
ISBN
douban_idstring
豆瓣 ID
titlestringrequired
书名
subtitlestring
副标题
original_titlestring
原作名
authorsAuthorBriefDto[]
作者列表
publishersPublisherBriefDto[]
出版社列表
publish_datestring
出版日期
pagesnumber
页数
pricestring
定价
bindingstring
装帧
seriesSeriesBriefDto[]
丛书列表
summarystring
内容简介
catalogstring
目录
cover_urlstring
封面 URL
douban_ratingnumber
豆瓣评分
douban_rating_countnumber
豆瓣评分人数
tagsTagBriefDto[]
标签列表
producersProducerBriefDto[]
出品方列表
created_atstringrequired
创建时间
updated_atstringrequired
更新时间
数据统计
1 个 GET 端点
GET/statistics/overview
获取系统数据统计快照
StatisticsOverview data
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| 当前接口没有额外参数。 | |||
availablebooleanrequired
统计快照是否可用
generatedAtstring | nullrequired
统计快照生成时间
generatedAtTimestampnumber | nullrequired
统计快照生成时间戳
metricsRecord<string, number> | nullrequired
按指标名聚合的系统统计数据
系统状态
1 个 GET 端点
GET/health
健康检查
object
| 参数 | 类型 | 描述 | 位置 |
|---|---|---|---|
| 当前接口没有额外参数。 | |||
阅览 API 指南
欢迎使用阅览 API 指南。这里整理了公开站点当前实际使用的 REST 接口、参数与统一响应结构。
认证鉴权
公开站点默认匿名访问；第三方调用方可按需在 Header 中携带 `X-API-Key`。
X-API-Key: YOUR_API_KEY
访问说明
所有接口都返回统一 envelope，页面展示的 response fields 只描述 data 字段。
公开站点默认匿名访问；第三方调用方可按需在请求头中携带 X-API-Key。
搜索、详情、关联、ISBN 与统计接口都集中在同一页，便于快速对照和联调。
搜索接口
通过关键词、类型、页码和分页大小检索公开图书实体。
GET
/search/querycurl -G "https://open-api.iyuelan.cn/search/query" \ --data-urlencode "keyword=三体" \ --data-urlencode "type=book" \ --data-urlencode "page=1" \ --data-urlencode "pageSize=20"
响应结构
所有响应都返回标准 JSON envelope。
codenumber
业务状态码，成功时为 200
messagestring
响应消息
dataobject
接口实际返回数据
timestampnumber
服务端响应时间戳
pathstring
命中的接口路径
端点列表
通用搜索
1 个端点
通用搜索
1 个端点
GET
/search/query通用关键词检索（图书/作者/出版社/丛书）
参数
keywordstring
搜索关键词
typeall | book | author | publisher | series
实体类型过滤
pagenumber
页码（>=1）
pageSizenumber
每页数量（1-50）
data 字段
keywordstring
原始搜索关键词
typeall | book | author | publisher | series
当前搜索类型
pagenumber
当前页码
pageSizenumber
每页数量
totalnumber
总命中数
totalPagesnumber
总页数
itemsEntityResponseItemDto[]
结构化实体列表，每项包含 entity_type、entity_id、entity
实体查询
7 个端点
实体查询
7 个端点
GET
/entities/{entityType}/{entityId}按实体类型和实体 ID 查询详情
参数
entityTypebook | author | publisher | series
实体类型
entityIdstring
实体 ID
data 字段
entity_typebook | author | publisher | series
实体类型
entity_idstring
实体 ID
entityRecord<string, unknown>
结构化实体详情，按 entity_type 返回图书/作者/出版社/丛书对应字段
GET
/entities/book/{entityId}/authors查询图书关联作者列表
参数
entityIdstring
图书 ID
pagenumber
页码
pageSizenumber
每页数量
data 字段
entity_typebook | author | publisher | series
主实体类型
related_typebook | author | publisher | series
关联实体类型
pagenumber
当前页码
pageSizenumber
每页数量
totalnumber
总条数
totalPagesnumber
总页数
itemsRecord<string, unknown>[]
关联实体列表，元素字段取决于 related_type
GET
/entities/book/{entityId}/publishers查询图书关联出版社列表
参数
entityIdstring
图书 ID
pagenumber
页码
pageSizenumber
每页数量
data 字段
entity_typebook | author | publisher | series
主实体类型
related_typebook | author | publisher | series
关联实体类型
pagenumber
当前页码
pageSizenumber
每页数量
totalnumber
总条数
totalPagesnumber
总页数
itemsRecord<string, unknown>[]
关联实体列表，元素字段取决于 related_type
GET
/entities/book/{entityId}/series查询图书关联丛书列表
参数
entityIdstring
图书 ID
pagenumber
页码
pageSizenumber
每页数量
data 字段
entity_typebook | author | publisher | series
主实体类型
related_typebook | author | publisher | series
关联实体类型
pagenumber
当前页码
pageSizenumber
每页数量
totalnumber
总条数
totalPagesnumber
总页数
itemsRecord<string, unknown>[]
关联实体列表，元素字段取决于 related_type
GET
/entities/author/{entityId}/books查询作者关联图书列表
参数
entityIdstring
作者 ID
pagenumber
页码
pageSizenumber
每页数量
data 字段
entity_typebook | author | publisher | series
主实体类型
related_typebook | author | publisher | series
关联实体类型
pagenumber
当前页码
pageSizenumber
每页数量
totalnumber
总条数
totalPagesnumber
总页数
itemsRecord<string, unknown>[]
关联实体列表，元素字段取决于 related_type
GET
/entities/publisher/{entityId}/books查询出版社关联图书列表
参数
entityIdstring
出版社 ID
pagenumber
页码
pageSizenumber
每页数量
data 字段
entity_typebook | author | publisher | series
主实体类型
related_typebook | author | publisher | series
关联实体类型
pagenumber
当前页码
pageSizenumber
每页数量
totalnumber
总条数
totalPagesnumber
总页数
itemsRecord<string, unknown>[]
关联实体列表，元素字段取决于 related_type
GET
/entities/series/{entityId}/books查询丛书关联图书列表
参数
entityIdstring
丛书 ID
pagenumber
页码
pageSizenumber
每页数量
data 字段
entity_typebook | author | publisher | series
主实体类型
related_typebook | author | publisher | series
关联实体类型
pagenumber
当前页码
pageSizenumber
每页数量
totalnumber
总条数
totalPagesnumber
总页数
itemsRecord<string, unknown>[]
关联实体列表，元素字段取决于 related_type
ISBN 查询
1 个端点
ISBN 查询
1 个端点
GET
/isbn/query通过 ISBN 查询图书详情（三方）
参数
isbnstring
ISBN 号码
data 字段
idstring
图书 ID
isbnstring
ISBN
douban_idstring
豆瓣 ID
titlestring
书名
subtitlestring
副标题
original_titlestring
原作名
authorsAuthorBriefDto[]
作者列表
publishersPublisherBriefDto[]
出版社列表
publish_datestring
出版日期
pagesnumber
页数
pricestring
定价
bindingstring
装帧
seriesSeriesBriefDto[]
丛书列表
summarystring
内容简介
catalogstring
目录
cover_urlstring
封面 URL
douban_ratingnumber
豆瓣评分
douban_rating_countnumber
豆瓣评分人数
tagsTagBriefDto[]
标签列表
producersProducerBriefDto[]
出品方列表
created_atstring
创建时间
updated_atstring
更新时间
数据统计
1 个端点
数据统计
1 个端点
GET
/statistics/overview获取系统数据统计快照
data 字段
availableboolean
统计快照是否可用
generatedAtstring | null
统计快照生成时间
generatedAtTimestampnumber | null
统计快照生成时间戳
metricsRecord<string, number> | null
按指标名聚合的系统统计数据
系统状态
1 个端点
系统状态
1 个端点
GET
/health健康检查
data 字段
需要更多帮助？
如果你需要对接站点的真实公开接口，可以直接通过搜索、详情和统计接口完成联调。
返回公开查询站点