孔夫子 item_search(官方标准名称 kfz.item.search)是按关键词、品相、价格、出版年代等多维度筛选二手书 / 古籍在售商品列表的核心接口,支持分页返回商品 ID、标题、价格、品相、店铺等基础信息,可联动 item_get 接口获取详情,适配二手书搜索、古籍筛选、竞品分析等场景。该接口采用 HTTPS+API Key/Secret 签名认证,支持 JSON/XML 双格式返回,具备二手书特色筛选维度完整、数据合规、权限分级严格的特点。本攻略从接口认知、权限获取、实操对接、调试排错到生产级优化,提供全链路结构化指导,兼顾入门易用性与企业级稳定性。
一、接口核心认知:功能与适配场景
- 接口定位与核心价值
核心功能:输入关键词(如 “鲁迅 呐喊 1981 年版”“清代 古籍 线装”),搭配品相、价格区间、出版年代、店铺评分等筛选条件,返回分页在售商品列表;支持按销量、价格、上架时间多维度排序,单页最多返回 50 条数据,适配商品搜索、古籍普查、二手书定价参考等场景。
孔夫子数据特性
二手书特色字段完整:覆盖品相等级、出版年代、装订方式、店铺评分等二手书 / 古籍专属维度,适配古籍珍本、二手教材、绝版书等特殊品类;
数据合规权威:商品数据源自孔夫子官方数据库,符合平台数据使用协议,支持商用场景;
筛选维度丰富:支持关键词模糊匹配、品相分级筛选(1-10 级)、价格区间过滤、出版年代范围查询、店铺评分筛选等 10 + 条件组合;
权限分级严格:基础商品列表开放度高,敏感数据(如店铺联系方式、区域库存)需企业授权或高级权限。
典型应用场景
二手书电商搜索:搭建二手书搜索页面,按关键词 + 品相 + 价格筛选在售商品,提升用户购物体验;
古籍普查与数字化:按 “清代 古籍”“民国 线装书” 等关键词筛选,批量获取古籍基础信息,辅助数字档案库建设;
二手书定价分析:获取同品相、同版本商品的价格分布,辅助二手书定价与估价;
店铺货源筛选:按店铺评分、销量筛选优质店铺的在售商品,提升采购效率。 - 核心参数与返回字段
(1)请求参数(GET/POST 提交,需签名认证)
参数类型 参数名称 类型 是否必填 说明 应用示例
公共参数 key string 是 调用 key(开发者平台获取) 12345678
secret string 是 调用密钥(开发者平台获取) abcdef123456
api_name string 是 接口名称,固定为 item_search item_search
result_type string 否 响应格式,支持 json/xml,默认 json json
cache string 否 是否缓存,yes/no,默认 yes yes
业务参数 q string 是 搜索关键词,需 URL 编码 鲁迅 呐喊 1981年版
category_id string 否 商品分类 ID(古籍 / 二手书 / 期刊等,从开放平台获取) 1001(古籍)
condition_level int 否 品相等级(1-10 级,10 为全新,默认不限) 8(九品)
price_min float 否 最低价格(元) 50
price_max float 否 最高价格(元) 500
year_min int 否 最低出版年代 1980
year_max int 否 最高出版年代 1990
sort_type string 否 排序方式 sales_desc(销量降序)/price_asc(价格升序)/publish_desc(上架时间降序)
page_num int 否 页码,默认 1 1
page_size int 否 单页条数,默认 20,最大 50 50
need_stock bool 否 是否返回库存状态(true = 是,false = 否,默认 false) true
注意事项
q 支持多条件组合(如 “鲁迅 呐喊 九品 1981”),接口自动分词模糊匹配;
condition_level 为 1-10 级,1 级为最差,10 级为全新,需根据业务需求精准设置;
签名生成需包含所有非空参数,按 ASCII 升序排序后拼接 Secret 进行 MD5 加密,缺一不可。
(2)返回核心字段(按业务场景分类)
字段分类 核心字段 说明
基础商品信息 num_iid 商品唯一 ID
title 商品主标题
author 作者
publisher 出版社
publish_year 出版年代
binding 装订方式(平装 / 精装 / 线装等)
价格与品相 current_price 当前售价(元)
original_price 原价(元)
condition_level 品相等级(1-10 级)
condition_desc 品相描述(如 “九品 略有磨损”)
库存与店铺 stock 库存量(需 need_stock=true)
shop_name 店铺名称
shop_score 店铺评分
shop_url 店铺链接
多媒体数据 cover_url 商品封面图 URL
分页信息 total 搜索结果总数
page_num 当前页码
page_size 单页条数
has_next 是否有下一页(true/false)
提示:item_search 仅返回商品基础信息,商品详情、完整属性、售后政策等需调用 item_get 接口获取。 - 接口限制与注意事项
权限类型 日调用上限 调用频率 适用场景
个人测试权限 100 次 / 天 2 次 / 秒 功能调试、个人研究
企业基础权限 1000 次 / 天 5 次 / 秒 中小型电商商品展示、市场调研
企业高级权限 10000 次 / 天 20 次 / 秒 大型电商平台、古籍数字化项目、价格监控系统
数据缓存规则:基础信息缓存 15 分钟,价格、库存、品相状态等动态数据实时同步;
内容限制:下架、删除商品不返回数据,敏感数据(如店铺联系方式)需企业授权;
合规要求:数据仅用于合规电商运营、市场调研、古籍数字化等业务,遵守孔夫子开放平台协议,严禁转售、泄露或用于非法用途。
二、对接前准备:权限与环境搭建 - 获取接口权限(官方唯一合规路径)
孔夫子 item_search 接口由孔夫子开放平台提供,接入步骤如下:
登录孔夫子开放平台,注册企业 / 个人开发者账号;
提交资质审核:企业账号上传营业执照、法人身份证,个人账号上传身份证,填写应用用途说明(如 “二手书电商搜索功能”);
创建应用,选择应用类型为 “电商服务”,填写应用名称、服务器 IP 白名单、数据用途,提交审核;
审核通过后,获取 key 和 secret(接口调用核心凭证),配置 IP 白名单;
申请 kfz.item.search 接口权限,根据业务需求选择权限等级(基础 / 进阶 / 高级)。
风险提示:严禁使用非合规爬虫、第三方代理接口抓取数据,违反平台协议会导致账号封禁、法律追责。 - 技术环境准备
(1)支持语言与协议
协议:HTTPS(强制,HTTP 请求会被直接拦截);
开发语言:Python、Java、PHP、Go 等主流语言,推荐 Python(适配签名生成、异步并发与数据解析)。
(2)必备工具与依赖
工具类型 推荐工具 用途
调试工具 孔夫子开放平台调试工具 自动生成签名,验证参数与响应结果
Postman 模拟 GET/POST 请求,排查代码逻辑问题
时间戳生成器 获取秒级时间戳,确保签名参数正确
开发依赖 requests 发送 HTTPS 请求
hashlib 生成 MD5 签名,确保接口安全
jsonpath-ng 快速解析嵌套 JSON 响应数据
pandas 批量整理商品列表数据,生成 Excel 报告
辅助工具 Redis 缓存搜索结果,减少接口调用次数
logging 记录接口调用日志,便于审计与问题追溯
三、实操步骤:接口对接全流程(Python 示例)
步骤 1:理解签名认证规则(核心,必掌握)
孔夫子接口采用 key+secret 签名认证 机制,签名生成步骤如下:
收集所有非空请求参数(含公共参数与业务参数);
按参数名 ASCII 升序排序;
拼接参数为 key1value1key2value2... 格式;
拼接 secret,生成字符串;
对字符串进行 MD5 加密,得到签名(sign);
将签名添加到请求参数中,发送请求。
步骤 2:完整代码实现(含签名生成 + 调用 + 数据标准化)
(1)依赖安装
bash
运行
pip install requests hashlib jsonpath-ng pandas
(2)Python 代码实现
import requests
import hashlib
import time
import logging
import pandas as pd
from urllib.parse import quote
日志配置
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s - %(levelname)s - %(message)s",
handlers=[logging.FileHandler("kongfz_item_search.log"), logging.StreamHandler()]
)
配置信息(替换为你的孔夫子开放平台信息)
CONFIG = {
"key": "你的key",
"secret": "你的secret",
"api_url": "https://api-gw.onebound.cn/kfz/item_search",
"result_type": "json",
"cache": "yes"
}
def generate_sign(params: dict, secret: str) -> str:
"""生成孔夫子接口签名(MD5加密)"""
# 1. 按参数名ASCII升序排序
sorted_params = sorted(params.items(), key=lambda x: x[0])
# 2. 拼接参数为key1value1key2value2...格式
param_str = "".join([f"{k}{v}" for k, v in sorted_params])
# 3. 拼接secret
sign_str = param_str + secret
# 4. MD5加密,转为小写
sign = hashlib.md5(sign_str.encode("utf-8")).hexdigest().lower()
return sign
def standardize_product_list_data(raw_product: dict) -> dict:
"""标准化孔夫子商品列表数据,统一输出格式"""
return {
"商品ID": raw_product.get("num_iid", ""),
"商品标题": raw_product.get("title", ""),
"作者": raw_product.get("author", ""),
"出版社": raw_product.get("publisher", ""),
"出版年代": raw_product.get("publish_year", ""),
"装订方式": raw_product.get("binding", ""),
"当前售价(元)": raw_product.get("current_price", 0.0),
"原价(元)": raw_product.get("original_price", 0.0),
"品相等级": raw_product.get("condition_level", 0),
"品相描述": raw_product.get("condition_desc", ""),
"库存": raw_product.get("stock", 0),
"店铺名称": raw_product.get("shop_name", ""),
"店铺评分": raw_product.get("shop_score", 0.0),
"封面图URL": raw_product.get("cover_url", ""),
"请求时间": time.strftime("%Y-%m-%d %H:%M:%S", time.localtime())
}
def kongfz_item_search(
keyword: str,
category_id: str = None,
condition_level: int = None,
price_min: float = None,
price_max: float = None,
year_min: int = None,
year_max: int = None,
sort_type: str = "sales_desc",
page_num: int = 1,
page_size: int = 20,
need_stock: bool = False
) -> dict:
"""调用孔夫子item_search接口获取在售商品列表"""
# 1. 校验必填参数
if not keyword:
return {"success": False, "error_msg": "关键词不能为空", "data": [], "pagination": {}}
# 2. 构建公共参数
params = {
"key": CONFIG["key"],
"api_name": "item_search",
"result_type": CONFIG["result_type"],
"cache": CONFIG["cache"],
"q": quote(keyword, encoding="utf-8"),
"sort_type": sort_type,
"page_num": page_num,
"page_size": min(page_size, 50), # 单页最大50条
"need_stock": str(need_stock).lower()
}
# 3. 补充分筛参数
if category_id:
params["category_id"] = category_id
if condition_level is not None and 1 <= condition_level <= 10:
params["condition_level"] = condition_level
if price_min is not None:
params["price_min"] = price_min
if price_max is not None:
params["price_max"] = price_max
if year_min is not None:
params["year_min"] = year_min
if year_max is not None:
params["year_max"] = year_max
# 4. 生成签名
sign = generate_sign(params, CONFIG["secret"])
params["sign"] = sign
try:
# 5. 发送GET请求
response = requests.get(
url=CONFIG["api_url"],
params=params,
timeout=10,
verify=True
)
response.raise_for_status()
result = response.json()
# 6. 解析响应结果
if result.get("error_response"):
error = result["error_response"]
error_msg = f"{error.get('code', '')}: {error.get('msg', '')}"
logging.error(f"接口调用失败:{error_msg}")
return {"success": False, "error_msg": error_msg, "data": [], "pagination": {}}
search_result = result.get("item_search_response", {}).get("products", {})
raw_products = search_result.get("product", [])
if not raw_products:
logging.warning(f"无商品数据返回(关键词:{keyword})")
return {"success": False, "error_msg": "无匹配商品", "data": [], "pagination": {}}
# 7. 标准化数据与分页信息
standard_products = [standardize_product_list_data(p) for p in raw_products]
pagination = {
"total": int(search_result.get("total", 0)),
"page_num": page_num,
"page_size": page_size,
"has_next": search_result.get("has_next", False)
}
return {"success": True, "data": standard_products, "pagination": pagination, "error_msg": ""}
except requests.exceptions.RequestException as e:
logging.error(f"网络请求异常:{str(e)}")
return {"success": False, "error_msg": f"网络异常:{str(e)}", "data": [], "pagination": {}}
except Exception as e:
logging.error(f"数据解析异常:{str(e)}")
return {"success": False, "error_msg": f"解析异常:{str(e)}", "data": [], "pagination": {}}
调用示例
if name == "main":
keyword = "鲁迅 呐喊"
condition_level = 8 # 九品
price_min = 50.0
price_max = 200.0
year_min = 1980
year_max = 1990
sort_type = "sales_desc"
page_size = 20
result = kongfz_item_search(
keyword=keyword,
condition_level=condition_level,
price_min=price_min,
price_max=price_max,
year_min=year_min,
year_max=year_max,
sort_type=sort_type,
page_size=page_size,
need_stock=True
)
if result["success"]:
print(f"搜索成功:共 {result['pagination']['total']} 条结果,当前页 {len(result['data'])} 条")
for item in result["data"][:5]:
print(f"商品ID:{item['商品ID']} | 标题:{item['商品标题']} | 售价:{item['当前售价(元)']} | 品相:{item['品相描述']}")
# 保存为Excel
df = pd.DataFrame(result["data"])
df.to_excel(f"kongfz_product_search_{keyword}.xlsx", index=False)
# 翻页示例
if result["pagination"]["has_next"]:
next_page = kongfz_item_search(
keyword=keyword,
condition_level=condition_level,
price_min=price_min,
price_max=price_max,
year_min=year_min,
year_max=year_max,
sort_type=sort_type,
page_num=2,
page_size=page_size,
need_stock=True
)
print(f"下一页获取 {len(next_page['data'])} 条数据")
else:
print(f"搜索失败:{result['error_msg']}")
四、调试与问题排查:快速解决对接异常
- 优先用官方工具调试(排除签名与参数问题)
登录孔夫子开放平台调试工具,选择 kfz.item.search 接口;
输入关键词、品相等级、价格区间等参数,工具自动生成签名并发送请求;
若官方工具调用成功,说明代码的签名生成或参数拼接逻辑有误;若失败,检查权限或参数有效性。 - 高频问题排查表
问题现象 常见原因 解决方案
签名验证失败(401) 1. key/secret 错误; - 签名生成规则错误;
- 缓存参数与签名不匹配 1. 核对开放平台应用信息;
- 严格按 ASCII 升序排序参数,拼接 secret 后 MD5 加密;
- 确保缓存参数(cache)包含在签名生成中
权限不足(403) 1. 未申请 kfz.item.search 接口权限; - IP 不在白名单;
- 权限等级不足(如请求店铺联系方式) 1. 在开放平台申请对应权限;
- 添加服务器 IP 到白名单;
- 升级权限等级,申请敏感数据访问权限
参数错误(400) 1. 关键词为空; - condition_level 值非法(非 1-10);
- page_size>50 1. 确保关键词参数非空;
- condition_level 设置为 1-10;
- page_size 设置≤50
无商品数据返回 1. 关键词无匹配; - 筛选条件过严(如品相 8 级 + 价格 50-100 元无商品);
- 商品已下架 / 禁售 1. 简化关键词(如去掉 “1981 年版” 限制);
- 放宽筛选条件(如扩大价格区间、降低品相等级);
- 在孔夫子官网搜索关键词,确认商品状态
响应超时(504) 1. 网络波动; - page_size 过大(如 50 条);
- 高峰期调用 1. 添加重试机制;
- 减小 page_size(如改为 20);
- 避开高峰期(如工作日 10:00-12:00)
五、进阶优化:生产级稳定性提升 - 性能与配额优化
批量翻页优化:通过 has_next 判断是否继续翻页,避免无效请求;多关键词查询时采用异步并发(aiohttp),控制并发数≤权限允许的频率上限(如企业基础权限 5 次 / 秒);
智能缓存策略:用 Redis 缓存搜索结果,缓存 key 为 kongfzsearch关键词品相价格区间_页码,动态数据(价格、库存)缓存 5 分钟,基础信息缓存 15 分钟,减少重复调用;
字段精简:仅保留业务必需字段(如商品 ID、标题、价格、品相),减少响应体积与解析耗时。 - 数据质量优化
数据去重:按 num_iid 去重,避免同一商品重复出现;
异常值过滤:过滤售价≤0、品相等级非法(非 1-10)的商品,提升数据有效性;
关键词优化:对长关键词进行分词处理(如 “鲁迅 呐喊 1981 年版 九品”→“鲁迅 呐喊 九品”),提升搜索覆盖率。 - 合规与安全
密钥管理:生产环境将 key/secret 存储在配置中心(如 Nacos、Apollo),禁止硬编码;定期轮换密钥(每 3 个月一次);
重试机制:对 403(频率超限)、504(超时)等错误添加指数退避重试策略,首次重试间隔 1 秒,之后间隔翻倍,最多重试 3 次;
日志审计:记录每次调用的关键词、筛选条件、响应状态、数据条数,保留至少 30 天日志,满足合规审计要求。
六、扩展场景:接口联动与功能升级
联动 item_get 接口:通过 item_search 获取商品 ID 列表,批量调用 item_get 获取商品详情,实现 “搜索 - 详情” 全链路数据采集;
古籍数字化系统:定时调用 item_search 筛选古籍商品,提取版本、出版年代、品相描述等信息,构建古籍数字档案库;
二手书估价工具:基于商品品相、出版年代、作者、出版社等数据,构建二手书估价模型,提升估价准确性。