接入文档
接口简介
本接口提供基于特定地区和商品类目的农产品数据检索能力。开发者可通过传入商品名称、地区名称及可选日期,获取对应的市场参考信息,适用于需要整合多地农产品行情的业务系统。
适用场景
- 农业电商平台:根据用户所在地推荐当地特色农产品或显示实时参考价。
- 行情监控系统:自动化采集不同地区的特定农产品数据,生成价格趋势报表。
- 供应链采购:辅助采购人员对比不同产区的农产品供应情况。
请求与返回说明
- 请求方法:POST
- 核心参数:
categoryName(必填):商品名称,如“苹果”、“大米”。region(必填):地区名称,如“山东烟台”、“黑龙江”。date(选填):查询日期,格式 yyyy-MM-dd,默认为当天。- 返回结果:返回匹配该地区与类目的农产品相关数据对象,具体字段结构以实际响应为准。
接入建议
- 参数规范:地区名称建议使用标准行政区划或常见产地别名,以提高匹配准确率。
- 缓存策略:对于非实时性要求极高的展示场景,建议对相同地区和类目的查询结果进行短期缓存,减少 API 调用次数。
- 异常处理:请妥善处理无数据返回的情况,前端应给予用户友好的提示,而非直接报错。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"categoryName": "商品名称",
"region": "地区名称",
"date": "日期,格式:yyyy-MM-dd,默认当天"
}响应示例
{}请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.categoryName | object | {...} |
| properties.categoryName.type | string | string |
| properties.categoryName.description | string | 商品名称 |
| properties.region | object | {...} |
| properties.region.type | string | string |
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |