农产品行情
<h3>简介</h3>
<ul>
<li>提供国内大部分区域的特产农作物的产品种类的相关信息作为查阅参考。</li>
<li>提供了3个接口,分别为:支持产品查询、地区均价、最新参考价</li>
</ul>
<h3>接口调用说明</h3>
<h4>请求方式</h4>
<p>如接口没有单独说明,所有接口均为:<strong>POST</strong></p>
<h4>请求格式</h4>
<p>如接口没有单独说明,所有接口均为:<strong>application/form-data</strong></p>
<h4>请求参数</h4>
<p>请求参数均包括公共参数和业务参数(业务参数见具体接口说明)
如接口没有单独说明,所有接口调用时,均需要把<strong>公共参数</strong>和<strong>业务参数</strong>一并放在<strong>请求参数</strong>中提交</p>
<p><a name="公共请求参数"></a></p>
<h5>公共请求参数</h5>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>appId</td>
<td>String</td>
<td>是</td>
<td>服务商分配的唯一标识</td>
</tr>
<tr>
<td>timestamp</td>
<td>Long</td>
<td>是</td>
<td>当前时间戳(毫秒)</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>签名,详见签名算法说明</td>
</tr>
</tbody>
</table>
<h5>签名算法说明</h5>
<pre><code>sign = sha256(appId + appSecret + timestamp)</code></pre>
<p>用服务商分配的 <strong>appId</strong>、服务商分配的 <strong>appSecret</strong>,当前时间戳(毫秒) <strong>timestamp</strong>,按上述顺序拼接成字符串,再进行 <strong>sha256</strong> 哈希得到。如下:</p>
<pre><code class="language-java">String appId = &quot;xyzxy2121zxyz&quot;;
String timestamp = &quot;1555378976238&quot;;
String appSecret = &quot;efcefcef1121cefcefc1212121&quot;;
String str = appId + appSecret + timestamp;
String sign = sha256(str);</code></pre>
<h4>返回说明</h4>
<h5>返回字段说明</h5>
<p>所有接口均返回以下公共字段:</p>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>返回码,详见:code返回码说明</td>
</tr>
<tr>
<td>msg</td>
<td>code对应的描述</td>
</tr>
<tr>
<td>charge</td>
<td>计费标志 true为计费,false为不计费</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果,object类型,详见data返回字段描述</td>
</tr>
</tbody>
</table>
<p><a name="code返回码说明"></a></p>
<h5>code返回码说明</h5>
<table>
<thead>
<tr>
<th>code</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功(计费)</td>
</tr>
<tr>
<td>201</td>
<td>没有找到相关内容,具体参考返回内容</td>
</tr>
<tr>
<td>400</td>
<td>参数错误</td>
</tr>
<tr>
<td>404</td>
<td>请求地址不正确</td>
</tr>
<tr>
<td>500</td>
<td>服务商维护,请稍候再试</td>
</tr>
<tr>
<td>601</td>
<td>接口未开通</td>
</tr>
<tr>
<td>602</td>
<td>账号停用</td>
</tr>
<tr>
<td>603</td>
<td>余额不足请充值</td>
</tr>
<tr>
<td>604</td>
<td>接口停用</td>
</tr>
<tr>
<td>604</td>
<td>接口停用</td>
</tr>
<tr>
<td>606</td>
<td>调用超限,请稍候再试</td>
</tr>
<tr>
<td>607</td>
<td>ip不在白名单</td>
</tr>
<tr>
<td>609</td>
<td>请求过于频繁,请稍候再试</td>
</tr>
<tr>
<td>610</td>
<td>请求超时</td>
</tr>
<tr>
<td>999</td>
<td>其他,以实际返回为准</td>
</tr>
</tbody>
</table>
<hr />
<h3>支持产品查询</h3>
<ul>
<li>查询支持的农产品,获得农产品代码,目前支持 畜产,水产,粮油,果品,蔬菜5大类农产品。</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/agricultural/products/query</code></p>
<h3>业务参数</h3>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>String</td>
<td>否</td>
<td>农产品名称,支持模糊查询</td>
</tr>
<tr>
<td>type</td>
<td>Integer</td>
<td>是</td>
<td>农产品种类,1表示畜产,2表示水产,3代表粮油,4代表果品,5代表蔬菜</td>
</tr>
</tbody>
</table>
<p>公共请求参数请参阅:<a href="#公共请求参数">公共请求参数</a></p>
<h3>成功返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 200,//返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,//返回码对应描述
&quot;taskNo&quot;: &quot;329903325198037812330158&quot;,//本次请求号
&quot;charge&quot;: true,//计费标志
&quot;data&quot;: [
{
&quot;genusCode&quot;: &quot;5&quot;,//产品种类代码
&quot;name&quot;: &quot;小白菜&quot;,//名称
&quot;genus&quot;: &quot;蔬菜&quot;,//产品种类
&quot;code&quot;: &quot;5xiao_bai_cai&quot;//农产品代码
}
]
}</code></pre>
<h3>失败返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 400,//返回码,详见返回码说明
&quot;msg&quot;: &quot;农产品种类不能为空&quot;,//返回码对应描述
&quot;charge&quot;: false //计费标志
}</code></pre>
<hr />
<h3>地区均价</h3>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/agricultural/products/region/average-price</code></p>
<h3>业务参数</h3>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>province</td>
<td>String</td>
<td>是</td>
<td>省份名称,暂不支持港澳台地区,省份名字不带“省”字,譬如:浙江省,输入浙江</td>
</tr>
<tr>
<td>city</td>
<td>String</td>
<td>否</td>
<td>地级市名称</td>
</tr>
<tr>
<td>code</td>
<td>String</td>
<td>是</td>
<td>农产品代码,通过【支持产品查询】接口获取的code</td>
</tr>
</tbody>
</table>
<p>公共请求参数请参阅:<a href="#公共请求参数">公共请求参数</a></p>
<h3>成功返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 200,//返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,//返回码对应描述
&quot;taskNo&quot;: &quot;237383294207289816552817&quot;,//本次请求号
&quot;charge&quot;: true,//计费标志
&quot;data&quot;: {
&quot;unit&quot;: &quot;斤&quot;,//计价单位
&quot;avg&quot;: &quot;1.11&quot;,//参考均价
&quot;sample&quot;: &quot;8&quot;//样本数量
}
}</code></pre>
<h3>失败返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 201,//返回码,详见返回码说明
&quot;msg&quot;: &quot;没有找到:浙江省&quot;,//返回码对应描述
&quot;taskNo&quot;: &quot;060714638224956686378313&quot;,//本次请求号
&quot;charge&quot;: false //计费标志
}</code></pre>
<hr />
<h3>最新参考价</h3>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/agricultural/products/lastest/reference-price</code></p>
<h3>业务参数</h3>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>province</td>
<td>String</td>
<td>是</td>
<td>省份名称,暂不支持港澳台地区,省份名字不带“省”字,譬如:浙江省,输入浙江</td>
</tr>
<tr>
<td>city</td>
<td>String</td>
<td>否</td>
<td>地级市名称</td>
</tr>
<tr>
<td>code</td>
<td>String</td>
<td>是</td>
<td>农产品代码,通过【支持产品查询】接口获取的code</td>
</tr>
</tbody>
</table>
<p>公共请求参数请参阅:<a href="#公共请求参数">公共请求参数</a></p>
<h3>成功返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 200,//返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,//返回码对应描述
&quot;taskNo&quot;: &quot;084794757222548674607811&quot;,//本次请求号
&quot;charge&quot;: true,//计费标志
&quot;data&quot;: [
{
&quot;money&quot;: &quot;0.5&quot;,//价格
&quot;unit&quot;: &quot;斤&quot;,//单位
&quot;address&quot;: &quot;北京市通州区通惠北路金龙街4号&quot;,//价格获取地址(单位)
&quot;date&quot;: &quot;2023-10-26&quot; //更新时间
}
]
}</code></pre>
<h3>失败返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 400,//返回码,详见返回码说明
&quot;msg&quot;: &quot;省名称不能为空&quot;,//返回码对应描述
&quot;charge&quot;: false //计费标志
}</code></pre>