加盟网item_search接口是招商加盟领域核心的行业批量检索接口 ,专为加盟招商平台、创业服务系统、企业招商中台、行业数据分析平台设计,通过行业关键词、投资门槛、行业分类、加盟热度 等多维度筛选条件,精准获取符合要求的加盟行业列表,支持分页、排序、字段过滤等 B 端核心功能。该接口采用HTTPS+AppKey/Secret+Sign 签名 的企业级安全认证机制,支持 JSON/XML 双格式返回,数据经平台大数据整合与行业调研每日同步,具备检索维度全、匹配精度高、数据时效性强、适配规模化批量调用的特点,是实现加盟行业智能检索、创业赛道匹配、招商市场分析的核心工具。本攻略从接口核心认知、权限准备、参数规范、实操对接、调试排错到生产级优化,提供全链路标准化对接指导,覆盖从入门到精通的所有核心要点,适配各类 B 端业务系统集成需求。
一、接口核心认知:功能定位与适配场景
1. 核心价值与核心能力
该接口解决加盟招商领域行业多维度批量检索、精准筛选、规模化数据采集的核心需求,区别于通用行业检索接口,专为加盟招商赛道定制化开发,核心能力如下:
- 多维度组合检索 :支持行业关键词模糊匹配 +投资门槛区间筛选 +上级行业分类精准过滤 +加盟热度排序,实现多条件下的精准行业检索,适配不同业务的筛选需求;
- B 端场景深度适配:支持分页查询(单页最大 50 条)、按加盟热度 / 市场规模 / 投资门槛排序、自定义返回字段,数据结构化程度高,无需二次加工即可直接嵌入业务系统;
- 数据实时同步更新 :行业基础信息缓存 24 小时,加盟热度、投资门槛、市场规模等动态信息每日同步更新 ,检索结果列表缓存 30 分钟,支持
no_cache参数强制刷新,保障数据时效性; - 规模化调用支持:采用企业级分级权限管控,从个人测试的 1 次 / 秒到大型平台的 50 次 / 秒,满足小批量查询到高并发检索的全场景需求,适配不同规模企业的业务需求。
2. 典型 B 端应用场景
- 加盟招商平台:为创业者提供行业检索功能,支持按关键词、预算筛选加盟行业,搭配行业详情展示,实现创业赛道快速匹配;
- 创业服务系统:根据用户创业预算、地域、行业偏好,通过多维度筛选检索适配的加盟行业,生成个性化创业赛道推荐;
- 企业招商中台:检索不同加盟行业的市场规模、加盟热度、投资门槛,分析各赛道招商潜力,为企业招商赛道选择提供数据支撑;
- 行业数据分析平台:批量采集加盟行业列表数据,分析各细分赛道的发展趋势、市场格局、投资热度,输出加盟行业研究报告;
- 加盟风控系统:检索高风险加盟赛道(如低盈利、高投入、政策限制),建立风险行业库,为创业者提供加盟风险预警。
3. 接口分级权限与调用限制
接口采用企业级分级权限管控,个人仅可申请测试权限(仅限功能调试,不可用于生产业务),企业根据业务规模可申请基础 / 高级 / 定制权限,不同权限对应不同的调用配额、频率和功能上限,可根据企业资质申请升级,通用权限规范如下(支持定制化配额):
| 权限类型 | 日调用上限 | 调用频率 | 单页最大条数 | 适用场景 |
|---|---|---|---|---|
| 个人测试权限 | 200 次 / 天 | 1 次 / 秒 | 20 条 | 功能调试、单个关键词小范围检索 |
| 企业基础权限 | 5000 次 / 天 | 5 次 / 秒 | 30 条 | 中小加盟平台、小型创业服务机构 |
| 企业高级权限 | 10 万次 / 天 | 20 次 / 秒 | 50 条 | 大型加盟招商平台、头部创业服务企业 |
| 定制尊享权限 | 按需配置 | 50 次 / 秒 | 50 条 | 政企招商平台、行业大数据分析机构 |
通用注意事项:
- 数据使用合规:接口返回数据仅可用于企业内部业务运营、平台内容展示、合法的行业分析,严禁转售、篡改、伪造行业数据,严禁用于虚假招商宣传;
- 关键词匹配规则:支持中文关键词模糊匹配(如 "茶饮" 匹配 "新式茶饮""新中式茶饮"),关键词长度限制 2-10 个字符,仅支持纯中文,无特殊字符 / 数字 / 字母;
- 行业范围限制:仅覆盖加盟招商主流赛道(餐饮、美妆、零售、母婴、服务、教育等),非加盟类行业无返回数据;
- 筛选规则限制:投资门槛筛选为区间匹配(仅返回符合最小 / 最大投资额的行业),加盟热度为平台综合评分(1-5 星),按评分高低排序;
- 缓存规则:检索结果列表默认缓存30 分钟 ,相同筛选条件短时间内重复调用返回缓存数据,支持
no_cache=true强制刷新实时数据。
二、核心参数与返回字段规范
1. 请求参数(GET/POST 均可,推荐 POST,需签名认证)
参数分为公共参数 (加盟网所有接口通用,签名必备)和业务参数 (本接口专属),所有非空参数均参与签名,空参数不参与,参数名按 ASCII 升序排序 ,签名规则为加盟网开放平台统一标准,与同平台item_get接口通用。
公共参数(必填,无默认值,缺一不可)
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| app_key | string | 应用唯一标识,加盟网开放平台获取 | JM20260101ABCDE |
| method | string | 接口固定名称,不可修改 | item_search |
| format | string | 响应格式,可选 JSON/XML,默认 JSON | json |
| timestamp | string | 秒级时间戳,与服务器时差≤5 分钟 | 1735776000 |
| v | string | 接口版本,固定为 1.0 | 1.0 |
| sign | string | 接口签名,默认 MD5,高级权限可选 SHA256 | 9F2E478D6C1A3B5E790826451037ABCD |
业务参数(核心关键词必填,其余为筛选 / 分页可选)
| 参数名 | 类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| keyword | string | 是 | 检索关键词,2-10 个纯中文,模糊匹配 | 茶饮、母婴、零食零售 |
| parent_id | string | 否 | 上级行业 ID,精准过滤子行业,可从行业字典获取 | JY001(餐饮加盟)、JY005(母婴加盟) |
| invest_min | float | 否 | 最低投资额筛选(单位:万),仅返回≥该值的行业 | 10、20、50 |
| invest_max | float | 否 | 最高投资额筛选(单位:万),仅返回≤该值的行业 | 30、50、100 |
| hot_level | int | 否 | 加盟热度筛选(1-5 星),仅返回≥该星级的行业 | 3、4、5 |
| sort_type | string | 否 | 排序方式,默认 hot_desc | hot_desc/hot_asc/invest_asc/invest_desc/market_desc |
| page_num | int | 否 | 页码,默认 1,从 1 开始 | 2、3 |
| page_size | int | 否 | 单页条数,默认 20,最大 50 | 30、50 |
| fields | string | 否 | 字段过滤,指定返回字段,英文逗号分隔 | industry_id,industry_name,invest_min,invest_max |
| no_cache | bool | 否 | 是否强制刷新缓存,默认 false | true |
关键提示:
- sort_type 排序值说明:hot_desc(加盟热度从高到低)、hot_asc(加盟热度从低到高)、invest_asc(投资额从低到高)、invest_desc(投资额从高到低)、market_desc(市场规模从高到低);
- 上级行业 ID 可通过加盟网开放平台行业字典接口获取,提前同步至业务系统,便于精准筛选子行业;
- 投资门槛筛选支持单独传 min/max 或同时传,单独传时仅做单边过滤(如仅传 invest_min=10,返回≥10 万的行业);
- fields 参数传入不存在的字段会被自动忽略,未指定时返回全量字段;
- 布尔类型参数(no_cache)必须传入小写 true/false,传入大写会触发参数错误;
- 多条件筛选为且关系,即同时满足关键词、parent_id、投资门槛、热度的行业才会被返回。
2. 返回核心字段(JSON 格式,含分页 + 行业列表)
返回数据分为响应状态头 (判断调用成败)、分页信息 (便于翻页采集)、行业列表数据体 (核心检索结果),状态头为加盟网所有接口统一格式,数据体随入参过滤条件动态调整,未指定fields时返回全量字段,核心字段按加盟招商业务场景分类,适配 B 端系统集成与展示需求。
响应状态头(必返,统一格式)
| 字段名 | 类型 | 说明 | 成功示例 | 失败示例 |
|---|---|---|---|---|
| code | int | 响应码,200 为成功 | 200 | 401/403/400/404/500 |
| msg | string | 响应信息 | success | 签名验证失败 / 关键词过长 / 行业无匹配 |
| request_id | string | 唯一请求 ID,用于平台问题排查 | JM202601301000019F2E | - |
| cost_time | float | 接口调用耗时,单位秒 | 0.08 | - |
分页信息(必返,便于批量翻页)
| 字段名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| total | int | 符合条件的行业总条数 | 18 |
| page_num | int | 当前页码 | 1 |
| page_size | int | 当前单页条数 | 20 |
| has_next | bool | 是否有下一页 | false/true |
行业列表核心业务字段(单条行业数据)
| 字段分类 | 核心字段 | 类型 | 说明 | 新式茶饮行业示例 |
|---|---|---|---|---|
| 基础标识信息 | industry_id | string | 平台行业唯一 ID | JY023 |
| industry_name | string | 行业标准名称 | 新式茶饮加盟 | |
| parent_id | string | 上级行业 ID | JY001 | |
| parent_name | string | 上级行业名称 | 餐饮加盟 | |
| industry_desc | string | 行业简短描述 | 以鲜果、茶底为核心的新式饮品加盟赛道 | |
| 投资核心参数 | invest_min | float | 行业最低加盟投资额(万) | 10 |
| invest_max | float | 行业最高加盟投资额(万) | 80 | |
| shop_area | string | 行业建议门店面积 | 15-80㎡ | |
| join_mode | string | 行业主流加盟模式 | 单店加盟、区域代理 | |
| 市场核心数据 | market_scale | string | 行业年度市场规模(亿) | 890 亿 |
| growth_rate | string | 行业年同比增长率 | 12.5% | |
| brand_num | int | 行业加盟品牌数量 | 2300+ | |
| 加盟热度数据 | hot_level | int | 加盟热度星级(1-5 星) | 5 |
| hot_reason | string | 热度核心原因 | 低门槛、高盈利、回本快 | |
| 盈利基础数据 | avg_month_profit | string | 单店平均月盈利(万) | 3-8 |
| return_period | string | 平均投资回报周期 | 6-12 个月 |
提示:
- 部分字段随行业特性动态返回,如非实体门店类行业(线上加盟、知识付费)无
shop_area字段,小众加盟行业无growth_rate字段,对接时需做好空值兼容处理;- 数值型字段(如 market_scale、avg_month_profit)部分返回带单位字符串,便于直接展示,如需数值计算可做字符串切割 / 类型转换处理;
- 加盟热度
hot_level由平台综合品牌数量、加盟申请量、行业盈利数据、用户关注度等因素计算得出,星级越高代表加盟热度越高。
三、签名认证规则(核心必掌握,对接成败关键)
加盟网item_search接口采用企业级 MD5 加密签名 (企业高级权限可申请 SHA256 加密,安全性更高),签名规则为加盟网开放平台所有接口统一标准 ,与同平台item_get、brand_search等接口完全通用,错误的签名会直接触发 401 签名验证失败,需严格遵循以下步骤,无任何例外。
通用签名步骤(MD5 为例,全平台通用)
- 收集参数 :整理所有非空 的公共参数 + 业务参数 ,排除 sign 字段和 app_secret(应用秘钥),空参数直接忽略,不参与后续步骤;
- 参数排序 :将收集到的参数按参数名 ASCII 码升序排序(如 app_key 排在 format 之前,keyword 排在 parent_id 之前);
- 拼接参数字符串 :按
key1=value1&key2=value2&key3=value3的格式拼接,键值对无空格、无多余字符,分隔符为英文 &,严禁使用中文 & 或分号; - 拼接秘钥生成原串 :将app_secret (加盟网开放平台获取,需严格保密)直接拼接在参数字符串的末尾,无任何分隔符,生成签名原串;
- 加密生成签名 :对签名原串进行UTF-8 编码 后做 MD5 加密,生成 32 位十六进制字符串,大小写不敏感(推荐统一使用大写),即为 sign 参数值;
- 提交请求:将生成的 sign 参数加入请求参数中,发送 HTTPS 请求(GET 拼 URL、POST 放请求体 / 参数栏均可,推荐 POST,避免参数泄露)。
签名实操示例(快速理解,避免踩坑)
配置信息(需替换为自身实际配置)
app_key=JM20260101ABCDE,app_secret=ABC123DEF456GHI789JKL,api_url
本次请求参数
keyword = 茶饮,parent_id=JY001,invest_min=10,invest_max=50,hot_level=4,sort_type=hot_desc,page_num=1,page_size=20,method=item_search,format=json,timestamp=1735776000,v=1.0
签名步骤落地
- 非空参数整理:app_key、format、hot_level、invest_max、invest_min、keyword、method、page_num、page_size、parent_id、sort_type、timestamp、v;
- ASCII 升序排序:按参数名字母顺序排列,结果为:app_key、format、hot_level、invest_max、invest_min、keyword、method、page_num、page_size、parent_id、sort_type、timestamp、v;
- 拼接参数字符串 :
app_key=JM20260101ABCDE&format=json&hot_level=4&invest_max=50&invest_min=10&keyword=茶饮&method=item_search&page_num=1&page_size=20&parent_id=JY001&sort_type=hot_desc×tamp=1735776000&v=1.0 - 拼接秘钥生成原串:上述字符串 + ABC123DEF456GHI789JKL(无分隔符);
- MD5 加密 :对原串做 UTF-8 编码后进行 MD5 加密,生成 32 位大写字符串,假设为
9F2E478D6C1A3B5E790826451037ABCD; - 最终请求参数:上述所有参数 + sign=9F2E478D6C1A3B5E790826451037ABCD。
签名五大核心禁忌(90% 的签名错误源于此)
- 禁止将app_secret加入参与排序的参数中,仅作为最后一步的拼接秘钥,严禁泄露 app_secret 给任何第三方;
- 禁止使用毫秒级时间戳,必须为秒级(Python:int (time.time ()),Java:System.currentTimeMillis ()/1000),与服务器时差超过 5 分钟直接签名失败;
- 禁止空参数参与拼接(如未传 hot_level 参数,则不将 hot_level 加入参数列表);
- 禁止拼接时添加多余空格、换行符、中文逗号 / 分号,参数字符串必须为连续的纯英文格式;
- 禁止参数名 / 值大小写错误(如将 Timestamp 写成 timestamp,true 写成 True,method 写成 Item_Search,sort_type 写成 Hot_Desc)。
四、对接前准备:权限获取与技术环境搭建
1. 接口权限获取(官方唯一合规路径,企业实名审核)
加盟网item_search接口为企业级商用接口 ,个人仅可申请测试权限(仅限功能调试,不可用于生产业务),企业可申请正式权限,权限需通过加盟网开放平台 申请,全程为实名审核,审核周期 1-3 个工作日,与同平台item_get接口申请流程通用,可一次性完成权限申请,通用步骤如下:
- 注册开发者账号 :访问加盟网开放平台官网,选择企业开发者 / 个人开发者 ,填写手机号 / 邮箱,完成验证码验证,设置登录密码;
- 企业开发者:需填写企业全称、统一社会信用代码、法人姓名,信息需与营业执照一致;
- 个人开发者:需填写真实姓名、身份证号,仅可申请测试权限。
- 完成实名认证 :
- 企业开发者:上传营业执照原件扫描件 (加盖企业公章)、法人身份证正反面扫描件、《接口使用合规承诺书》(平台提供模板,加盖企业公章后上传);
- 个人开发者:上传本人身份证正反面扫描件,填写接口使用用途(仅用于功能测试,不可商用)。
- 创建应用 :在开发者后台进入「应用管理 - 创建应用」,填写真实有效信息,核心配置如下:
- 应用基本信息:应用名称、应用类型(如加盟招商平台、创业服务系统、行业数据分析);
- 服务器配置:服务器公网 IP 白名单(仅白名单内的 IP 可调用接口,支持多个 IP,用英文逗号分隔)、应用访问域名;
- 业务信息:数据使用用途、目标用户、预计日调用量,便于平台匹配合适的权限等级。
- 获取密钥 :应用提交审核后,平台将在 1-3 个工作日完成审核,审核通过后,在「应用管理 - 密钥管理」中获取
app_key和app_secret;⚠️ 重要 :app_secret仅可查看一次,需立即保存至安全位置(如配置中心、加密文件),切勿泄露,严禁硬编码在代码中。 - 申请接口权限 :在开发者后台进入「权限管理 - 行业服务」,选择item_search - 根据关键词获取行业列表 接口,同时可勾选
item_get等相关接口,根据业务需求选择权限类型(测试 / 基础 / 高级 / 定制),提交后:- 测试权限:即时开通,可调用接口,限制日调用 200 次,单页最大 20 条,仅返回核心字段;
- 正式权限:平台人工审核,审核通过后开通,按申请的权限类型分配调用配额、频率和功能权限。
- 获取行业字典 :在开发者后台进入「资源中心 - 行业字典」,下载全量加盟行业 ID、上级行业 ID 与对应名称的 Excel 文件,同步至业务系统,便于后续通过
parent_id精准筛选子行业,同时为前端提供行业选择下拉框数据。 - 测试联调 :平台提供测试环境 (测试域名 + 测试密钥 + 模拟测试数据),测试通过后,在开发者后台切换为正式环境(正式域名 + 正式密钥 + 真实行业数据),正式环境数据可直接用于生产业务。
风险提示:
- 服务器 IP 需填写公网 IP,内网 IP / 本地 IP 无法调用接口,若服务器 IP 变更,需及时在开放平台更新白名单,否则会触发 403 权限不足;
app_secret为接口签名的核心,严禁硬编码在前端代码、公共代码仓库、配置文件明文中,严禁泄露给第三方,若泄露需立即在开放平台重置密钥;- 测试环境数据为模拟数据,仅用于功能调试,正式环境数据为平台真实整合的行业数据,每日同步更新,保障数据时效性。
2. 技术环境准备(全主流语言支持,无框架限制)
该接口为通用 HTTPS 接口 ,支持所有主流开发语言和框架,无特殊技术限制,仅需准备基础开发环境 + 网络库 + 加密库 ,所有依赖均为轻量型,无需额外搭建复杂环境,与同平台item_get接口技术环境通用,可复用现有开发环境,推荐配置如下:
基础开发环境(任选其一,满足业务系统技术栈即可)
- Python:3.8+,推荐框架:Flask/Django/FastAPI(轻量接口对接推荐 Flask);
- Java:8+,推荐框架:SpringBoot/SpringMVC(企业级系统首选,适配高并发);
- PHP:7.4+,推荐框架:Laravel/ThinkPHP(招商平台常用技术栈,快速开发);
- Go:1.18+,原生 net/http 库(高并发场景首选,性能最优);
- Node.js:14+,推荐框架:Express/Koa(前端一体化系统首选)。
必备核心库(所有语言均原生 / 轻量支持,无需复杂安装)
| 开发语言 | 网络库(发送 HTTPS 请求) | 加密库(MD5/SHA256) | JSON 解析库 |
|---|---|---|---|
| Python | requests(推荐)/urllib | hashlib(原生) | json(原生) |
| Java | OkHttp(推荐)/HttpClient | commons-codec / 原生 MessageDigest | fastjson2/Gson/Jackson |
| PHP | curl(原生) | hash(原生) | json(原生) |
| Go | net/http(原生) | crypto/md5(原生) | encoding/json(原生) |
| Node.js | axios(推荐)/request | crypto(原生) | JSON(原生) |
调试 / 排错必备工具(提升对接效率,避免踩坑)
| 工具类型 | 推荐工具 | 核心用途 |
|---|---|---|
| 接口调试工具 | Apifox/Postman(推荐 Apifox) | 模拟请求,手动生成参数 / 签名,测试接口是否成功,快速定位问题 |
| 日志工具 | Python logging/Java Logback/ELK | 记录全量调用日志(请求参数、签名、返回数据、耗时),便于问题排查 |
| 缓存工具 | Redis(推荐) | 缓存检索结果列表,降低接口调用频率,提升响应速度 |
| 时间同步工具 | 加盟网平台时间接口 | 同步服务器时间,避免时间戳误差导致签名失败 |
| 监控工具 | Prometheus/Grafana/ELK | 监控接口调用量、成功率、耗时、错误码,及时发现异常 |
五、实操对接:全语言完整代码示例(核心落地)
通用对接原则(所有语言均遵循,提升代码可维护性)
- 封装签名生成方法:作为公共工具方法,供加盟网所有接口(如 item_search、item_get、brand_search)复用,避免重复代码;
- 封装接口调用方法:统一处理请求、响应、异常捕获、日志记录,降低业务代码与接口调用的耦合度;
- 做好入参严格校验:对必传参数、参数长度、参数格式、数值范围做严格校验,提前规避参数错误;
- 做好空值兼容处理:对返回的动态字段做非空判断,使用默认值填充空值,避免空指针异常 / 键不存在异常;
- 记录全量合规日志:记录请求 ID、请求参数、签名(脱敏)、返回数据、调用耗时、错误信息,日志保留至少 30 天,满足问题排查与合规审计要求;
- 增加频率控制:对批量翻页调用添加频率控制,避免触发平台调用频率限制,导致 403 权限不足。
示例 1:Python3 完整对接代码(最简洁,推荐调试 / 中小平台使用)
步骤 1:安装依赖(仅需 requests,轻量无冗余)
bash
pip install requests
步骤 2:完整代码(含签名 + 调用 + 分页 + 异常处理 + 日志 + 批量翻页)
python
import requests
import hashlib
import time
import logging
from typing import Optional, Dict, List
# 封装好API供应商demo url=https://console.open.onebound.cn/console/?i=Lex
# 日志配置:记录全量调用日志,支持文件+控制台输出,含请求ID,编码为utf-8
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s - %(levelname)s - 请求ID:%(request_id)s - %(message)s",
handlers=[logging.FileHandler("jiameng_item_search.log", encoding="utf-8"), logging.StreamHandler()]
)
# 配置信息(替换为你的实际配置,测试/正式环境区分配置)
CONFIG = {
"app_key": "你的app_key",
"app_secret": "你的app_secret",
"api_url": "https://openapi.jiameng.com/api", # 正式环境域名,测试环境替换为平台提供的测试域名
"timeout": 15, # 请求超时时间,单位秒
"version": "1.0"
}
def generate_md5_sign(params: Dict[str, str], app_secret: str) -> str:
"""
生成MD5签名(公共方法,加盟网所有接口可复用)
:param params: 非空请求参数(不含sign)
:param app_secret: 应用秘钥
:return: 32位大写MD5签名
"""
# 1. 按参数名ASCII升序排序
sorted_params = sorted(params.items(), key=lambda x: x[0])
# 2. 拼接参数字符串
param_str = "&".join([f"{k}={v}" for k, v in sorted_params])
# 3. 拼接秘钥并加密
sign_str = f"{param_str}{app_secret}"
sign = hashlib.md5(sign_str.encode("utf-8")).hexdigest().upper()
return sign
def jiameng_item_search(
keyword: str,
parent_id: Optional[str] = None,
invest_min: Optional[float] = None,
invest_max: Optional[float] = None,
hot_level: Optional[int] = None,
sort_type: str = "hot_desc",
page_num: int = 1,
page_size: int = 20,
fields: Optional[str] = None,
no_cache: bool = False
) -> Dict:
"""
调用加盟网item_search接口,根据关键词获取行业列表
:param keyword: 检索关键词(必填,2-10个纯中文)
:param parent_id: 上级行业ID,精准过滤子行业
:param invest_min: 最低投资额筛选(万)
:param invest_max: 最高投资额筛选(万)
:param hot_level: 加盟热度筛选(1-5星)
:param sort_type: 排序方式,默认hot_desc
:param page_num: 页码,默认1
:param page_size: 单页条数,默认20,最大50
:param fields: 字段过滤,英文逗号分隔
:param no_cache: 是否强制刷新缓存,默认false
:return: 接口返回结果(含成功/失败信息、分页、行业列表)
"""
# 1. 入参严格校验
if not keyword or len(keyword) < 2 or len(keyword) > 10:
return {"success": False, "msg": "关键词为必填项,且为2-10个纯中文", "data": [], "pagination": {}, "request_id": ""}
if not all(c.ischinese() for c in keyword):
return {"success": False, "msg": "关键词仅支持纯中文,无数字/字母/特殊字符", "data": [], "pagination": {}, "request_id": ""}
if page_size > 50:
page_size = 50 # 强制限制最大单页条数
if hot_level and (hot_level < 1 or hot_level > 5):
return {"success": False, "msg": "加盟热度筛选仅支持1-5星", "data": [], "pagination": {}, "request_id": ""}
if CONFIG["app_key"] == "你的app_key" or CONFIG["app_secret"] == "你的app_secret":
return {"success": False, "msg": "请配置正确的app_key和app_secret", "data": [], "pagination": {}, "request_id": ""}
# 2. 构建公共参数
params = {
"app_key": CONFIG["app_key"],
"method": "item_search",
"format": "json",
"timestamp": str(int(time.time())),
"v": CONFIG["version"]
}
# 3. 构建业务参数
params["keyword"] = keyword
params["sort_type"] = sort_type
params["page_num"] = str(page_num)
params["page_size"] = str(page_size)
params["no_cache"] = str(no_cache).lower()
# 可选参数:非空则添加
if parent_id:
params["parent_id"] = parent_id
if invest_min is not None:
params["invest_min"] = str(invest_min)
if invest_max is not None:
params["invest_max"] = str(invest_max)
if hot_level is not None:
params["hot_level"] = str(hot_level)
if fields:
params["fields"] = fields
# 4. 生成签名并添加到参数
sign = generate_md5_sign(params, CONFIG["app_secret"])
params["sign"] = sign
# 5. 发送HTTPS POST请求(推荐POST,避免参数泄露)
try:
response = requests.post(
url=CONFIG["api_url"],
params=params,
timeout=CONFIG["timeout"],
verify=True # 生产环境必须开启证书验证,禁止设为False
)
response.raise_for_status() # 抛出4xx/5xx HTTP状态码异常
result = response.json()
request_id = result.get("request_id", "未知")
# 6. 解析返回结果
if result.get("code") == 200:
logging.info(f"行业列表检索成功,关键词:{keyword},命中条数:{result.get('data', {}).get('total', 0)}", extra={"request_id": request_id})
return {
"success": True,
"msg": result.get("msg", "success"),
"data": result.get("data", {}).get("list", []),
"pagination": {
"total": result.get("data", {}).get("total", 0),
"page_num": page_num,
"page_size": page_size,
"has_next": result.get("data", {}).get("has_next", False)
},
"request_id": request_id,
"cost_time": result.get("cost_time", 0)
}
else:
error_msg = f"接口返回错误:{result.get('msg', '未知错误')}"
logging.error(error_msg, extra={"request_id": request_id})
return {
"success": False,
"msg": error_msg,
"data": [],
"pagination": {},
"request_id": request_id
}
# 捕获网络请求异常(超时、连接失败、HTTP状态码错误等)
except requests.exceptions.RequestException as e:
error_msg = f"网络请求异常:{str(e)}"
logging.error(error_msg, extra={"request_id": "未知"})
return {"success": False, "msg": error_msg, "data": [], "pagination": {}, "request_id": "未知"}
# 捕获数据解析/其他系统异常
except Exception as e:
error_msg = f"数据解析/系统异常:{str(e)}"
logging.error(error_msg, extra={"request_id": "未知"})
return {"success": False, "msg": error_msg, "data": [], "pagination": {}, "request_id": "未知"}
def batch_get_industry_list(**kwargs) -> List[Dict]:
"""
批量获取行业列表(自动翻页,获取所有符合条件的行业)
:param kwargs: jiameng_item_search的所有参数(keyword为必填)
:return: 所有符合条件的行业列表数据
"""
all_data = []
page_num = 1
# 强制设置单页最大条数,减少请求次数
kwargs["page_size"] = min(kwargs.get("page_size", 20), 50)
while True:
kwargs["page_num"] = page_num
res = jiameng_item_search(**kwargs)
if not res["success"]:
logging.error(f"批量检索失败,页码:{page_num},错误:{res['msg']}")
break
page_data = res["data"]
if not page_data:
break
all_data.extend(page_data)
# 判断是否有下一页
if not res["pagination"]["has_next"]:
break
page_num += 1
time.sleep(0.5) # 控制翻页频率,避免触发平台频率限制
logging.info(f"批量检索完成,关键词:{kwargs['keyword']},最终获取行业条数:{len(all_data)}")
return all_data
# 封装好API供应商demo url=https://console.open.onebound.cn/console/?i=Lex
# 调用示例
if __name__ == "__main__":
# 示例1:单页检索------关键词"茶饮",上级餐饮行业,10-50万投资,4星及以上热度,按热度降序
single_res = jiameng_item_search(
keyword="茶饮",
parent_id="JY001",
invest_min=10,
invest_max=50,
hot_level=4,
sort_type="hot_desc",
page_size=30
)
if single_res["success"]:
print(f"单页检索成功,命中{single_res['pagination']['total']}条,当前页{len(single_res['data'])}条")
print("第一条行业信息:", single_res['data'][0] if single_res['data'] else "无")
# 示例2:批量检索------获取关键词"茶饮"的所有符合条件行业,自动翻页
# batch_data = batch_get_industry_list(
# keyword="茶饮",
# parent_id="JY001",
# invest_min=10,
# hot_level=3
# )
# print(f"批量检索成功,共获取{len(batch_data)}条行业数据")
示例 2:Java 核心代码片段(SpringBoot 适配,企业级系统首选)
步骤 1:引入 Maven 依赖(核心依赖,轻量无冗余,与 item_get 接口通用)
xml
<!-- OkHttp:发送HTTPS请求,性能优于原生HttpClient -->
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>4.12.0</version>
</dependency>
<!-- commons-codec:MD5加密,加盟网签名必备 -->
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
<version>1.15</version>
</dependency>
<!-- fastjson2:JSON解析,高效适配Java业务系统 -->
<dependency>
<groupId>com.alibaba.fastjson2</groupId>
<artifactId>fastjson2</artifactId>
<version>2.0.32</version>
</dependency>
步骤 2:核心代码(工具类 + 调用类,可直接嵌入 SpringBoot 项目,@Component 注入使用)
java
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import org.apache.commons.codec.digest.DigestUtils;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
# 封装好API供应商demo url=https://console.open.onebound.cn/console/?i=Lex
import java.util.*;
import java.util.concurrent.TimeUnit;
/**
* 加盟网item_search接口调用工具类(SpringBoot适配,可复用签名方法)
*/
public class JiamengItemSearchUtil {
// 配置信息(可移至application.yml,通过@Value注入,区分测试/正式环境)
private static final String APP_KEY = "你的app_key";
private static final String APP_SECRET = "你的app_secret";
private static final String API_URL = "https://openapi.jiameng.com/api";
private static final int TIMEOUT = 15;
private static final String VERSION = "1.0";
// 全局OkHttpClient实例,避免重复创建,提升性能
private static final OkHttpClient CLIENT = new OkHttpClient.Builder()
.connectTimeout(TIMEOUT, TimeUnit.SECONDS)
.readTimeout(TIMEOUT, TimeUnit.SECONDS)
.writeTimeout(TIMEOUT, TimeUnit.SECONDS)
.build();
/**
* 生成MD5签名(公共方法,加盟网所有接口可复用)
* @param params 非空请求参数(不含sign)
* @return 32位大写MD5签名
*/
public static String generateMd5Sign(Map<String, String> params) {
// 1. 按参数名ASCII升序排序
List<Map.Entry<String, String>> sortedList = new ArrayList<>(params.entrySet());
sortedList.sort(Comparator.comparing(Map.Entry::getKey));
// 2. 拼接参数字符串
StringBuilder paramStr = new StringBuilder();
for (Map.Entry<String, String> entry : sortedList) {
paramStr.append(entry.getKey()).append("=").append(entry.getValue()).append("&");
}
// 移除最后一个多余的&
String str = paramStr.substring(0, paramStr.length() - 1) + APP_SECRET;
// 3. MD5加密并转大写
return DigestUtils.md5Hex(str).toUpperCase();
}
/**
* 调用加盟网item_search接口,根据关键词获取行业列表
* @param keyword 检索关键词(必填)
* @param parentId 上级行业ID
* @param investMin 最低投资额(万)
* @param investMax 最高投资额(万)
* @param pageNum 页码
* @param pageSize 单页条数
* @return 解析后的JSON对象,包含成功状态、分页、行业列表
*/
public static JSONObject searchIndustryList(String keyword, String parentId, Float investMin, Float investMax, int pageNum, int pageSize) {
// 1. 入参基础校验
if (keyword == null || keyword.length() < 2 || keyword.length() > 10) {
return JSONObject.of("success", false, "msg", "关键词为必填项,且为2-10个纯中文");
}
if (pageSize > 50) {
pageSize = 50;
}
// 2. 构建请求参数
Map<String, String> params = new HashMap<>();
// 公共参数
params.put("app_key", APP_KEY);
params.put("method", "item_search");
params.put("format", "json");
params.put("timestamp", String.valueOf(System.currentTimeMillis() / 1000));
params.put("v", VERSION);
// 业务参数
params.put("keyword", keyword);
params.put("sort_type", "hot_desc");
params.put("page_num", String.valueOf(pageNum));
params.put("page_size", String.valueOf(pageSize));
params.put("no_cache", "false");
// 可选参数
if (parentId != null && !parentId.isEmpty()) {
params.put("parent_id", parentId);
}
if (investMin != null) {
params.put("invest_min", String.valueOf(investMin));
}
if (investMax != null) {
params.put("invest_max", String.valueOf(investMax));
}
// 3. 生成签名并添加到参数
String sign = generateMd5Sign(params);
params.put("sign", sign);
// 4. 构建POST请求(推荐POST,避免参数泄露)
RequestBody requestBody = RequestBody.create(
okhttp3.MediaType.parse("application/x-www-form-urlencoded;charset=UTF-8"),
mapToParamsStr(params)
);
Request request = new Request.Builder()
.url(API_URL)
.post(requestBody)
.build();
// 5. 发送请求并解析结果
try (Response response = CLIENT.newCall(request).execute()) {
if (response.isSuccessful() && response.body() != null) {
String jsonStr = response.body().string();
JSONObject result = JSON.parseObject(jsonStr);
if (200 == result.getIntValue("code")) {
JSONObject data = result.getJSONObject("data");
return JSONObject.of(
"success", true,
"data", data.getJSONArray("list"),
"pagination", JSONObject.of(
"total", data.getIntValue("total"),
"page_num", pageNum,
"page_size", pageSize,
"has_next", data.getBooleanValue("has_next")
),
"request_id", result.getString("request_id")
);
} else {
return JSONObject.of(
"success", false,
"msg", result.getString("msg"),
"request_id", result.getString("request_id")
);
}
} else {
return JSONObject.of("success", false, "msg", "HTTP请求失败,状态码:" + response.code());
}
} catch (Exception e) {
return JSONObject.of("success", false, "msg", "请求异常:" + e.getMessage());
}
}
/**
* 将Map参数转为POST请求参数字符串
* @param params 参数Map
* @return 参数字符串
*/
private static String mapToParamsStr(Map<String, String> params) {
StringBuilder sb = new StringBuilder();
for (Map.Entry<String, String> entry : params.entrySet()) {
sb.append(entry.getKey()).append("=").append(entry.getValue()).append("&");
}
return sb.length() > 0 ? sb.substring(0, sb.length() - 1) : "";
}
// 测试主方法
public static void main(String[] args) {
// 调用示例:关键词"茶饮",上级餐饮行业JY001,10-50万投资,第1页,50条/页
JSONObject result = searchIndustryList("茶饮", "JY001", 10.0f, 50.0f, 1, 50);
System.out.println(result);
if (result.getBooleanValue("success")) {
System.out.println("命中行业总数:" + result.getJSONObject("pagination").getIntValue("total"));
}
}
}
六、调试与问题排查:高频问题速解(覆盖 90% 的对接异常)
接口对接过程中,问题主要集中在签名验证、参数错误、权限不足、网络异常 四大类,与同平台item_get接口常见问题高度相似,推荐排查流程:先使用 Apifox/Postman 模拟请求→排除签名 / 参数问题→再排查代码问题→最后排查权限 / 网络问题,以下为高频问题及解决方案,附快速排查技巧,帮助快速定位并解决问题。
高频问题排查表(按出现频率排序)
| 问题现象 | 响应码 | 常见原因 | 解决方案 |
|---|---|---|---|
| 签名验证失败 | 401 | 1. app_key/app_secret 错误 / 过期;2. 时间戳与服务器时差 > 5 分钟;3. 参数未按 ASCII 升序排序;4. 空参数参与拼接;5. 签名原串拼接格式错误 | 1. 核对开放平台密钥,确认未输错,过期则重新申请;2. 调用加盟网平台时间接口同步时间,使用秒级时间戳;3. 打印参数列表,严格按 ASCII 升序排序;4. 过滤空参数,仅非空参数参与拼接;5. 按 key1=value1 & 格式拼接,移除多余字符 / 空格 |
| 权限不足 | 403 | 1. 未申请 item_search 接口权限;2. 服务器 IP 未加入白名单;3. 调用频率 / 配额超限;4. 测试权限调用正式环境数据;5. 单页条数超过权限上限 | 1. 在开放平台权限管理中确认已开通该接口;2. 添加服务器公网 IP 到白名单,等待 5 分钟生效;3. 降低调用频率,添加频率控制,查看平台配额监控;4. 测试环境用测试密钥 / 域名,正式环境用正式密钥 / 域名;5. 按权限设置单页条数(测试 20 / 基础 30 / 高级 50) |
| 参数错误 | 400 | 1. 关键词为空 / 长度 <2/>10;2. 关键词含非中文字符;3. 布尔参数传大写(True/TRUE);4. 热度筛选非 1-5 星;5. 字段过滤用中文逗号分隔 | 1. 确保关键词为 2-10 个纯中文;2. 过滤关键词中的数字 / 字母 / 特殊字符,仅保留中文;3. 布尔参数统一传入小写 true/false;4. 热度筛选仅传 1-5 的整数;5. 字段过滤用英文逗号分隔 |
| 无匹配行业数据 | 404 | 1. 关键词为非加盟类行业;2. 筛选条件过于严格(多条件叠加无匹配);3. 上级行业 ID 输入错误 | 1. 更换为加盟类行业关键词(餐饮、美妆、零售等);2. 逐步放宽筛选条件,先单关键词检索,再叠加条件;3. 核对加盟网行业字典,使用官方统一上级行业 ID |
| 无数据返回(200 但 list 为空) | 200 | 1. 关键词无匹配加盟行业;2. 缓存未更新导致无数据;3. 字段过滤传入全无效字段 | 1. 更换更通用的关键词(如 "新中式茶饮" 改为 "茶饮");2. 设置 no_cache=true 强制刷新缓存;3. 核对字段名,使用平台文档中的有效字段,或移除 fields 参数 |
| 响应超时 | 504 | 1. 网络波动 / 平台服务器负载高;2. 单页条数过大(50)且命中数据量多;3. 跨地域调用(海外服务器调用国内接口) | 1. 添加重试机制(最多 3 次),设置超时时间 15 秒;2. 减小单页条数(如 20),分批次获取;3. 选择就近的接口域名,使用国内服务器调用 |
| 服务器内部错误 | 500 | 1. 平台接口临时故障;2. 关键词含特殊字符(emoji、转义字符);3. 投资门槛传入非数值类型 | 1. 查看加盟网开放平台公告,等待故障修复,或联系平台技术支持;2. 对关键词做特殊字符过滤,仅保留纯中文;3. 确保投资门槛传入浮点型 / 整型数值,避免非数值字符 |
快速调试技巧(提升排错效率,避免反复踩坑)
- Apifox/Postman 模拟请求 :手动输入参数,按签名规则生成 sign,测试接口是否成功,成功后再对照代码排查,快速定位是代码问题 还是签名 / 参数问题;
- 打印全量调试日志 :在代码中打印参与签名的参数列表、签名原串、生成的 sign、请求 URL / 参数、返回数据,逐行核对签名步骤,找到错误点;
- 使用平台在线调试工具 :加盟网开放平台提供在线接口调试工具,自动生成签名,可直接使用该工具的签名对比代码生成的签名,快速定位签名错误;
- 单条件最小化测试 :先使用仅关键词的最简参数调用接口,成功后再逐步叠加其他参数(parent_id→invest_min→hot_level),定位哪个参数导致的问题;
- 核对行业字典:筛选上级行业 / 热度无结果时,先核对加盟网行业字典,确认存在对应的子行业 / 热度等级,避免无效筛选;
- 参数类型校验:对数值型参数(invest_min、invest_max、hot_level)做类型校验,确保传入的是数值,而非字符串 / 非数值字符。
七、生产级优化:稳定性与性能提升(从可用到好用)
测试环境对接成功后,需针对生产环境的高并发、高可用、高性能、合规安全 做深度优化,避免因调用量过大、网络异常、数据量过大导致业务故障,优化策略与同平台item_get接口通用,可复用现有优化架构,核心优化策略按优先级从高到低排序如下:
1. 性能优化:降低调用频率,提升响应速度(核心)
- 智能分层缓存策略 (推荐 Redis):根据筛选条件和数据特性设置不同缓存时间,减少接口调用量,提升检索速度:
- 普通检索结果:缓存30 分钟 ,key 设计为
jiameng_search_关键词_parentId_投资min_投资max_热度,如jiameng_search_茶饮_JY001_10_50_4; - 高频热门关键词检索:缓存1 小时,如 "茶饮""母婴""零食" 等;
- 强制刷新:对实时性要求高的场景(如行业数据分析),设置
no_cache=true强制刷新; - 缓存失效:加盟网平台发布行业数据更新公告时,主动删除相关缓存,确保数据时效性。
- 普通检索结果:缓存30 分钟 ,key 设计为
- 字段按需加载 :不同业务场景调用不同字段,如创业用户展示 仅需
industry_id、industry_name、invest_min、invest_max、hot_level,无需返回industry_desc、growth_rate,减少数据传输量和解析耗时; - 批量翻页优化 :自动翻页时添加频率控制(如每次翻页间隔 0.5-1 秒),避免短时间内大量请求触发频率限制;单页条数设置为 ** 权限允许