二维码生成备份(作废)
<h3>接口描述</h3>
<ul>
<li>支持基本的二维码,指定颜色的二维码,带logo的二维码及指定背景(支持gif动态图)的二维码的生成。其中指定背景的二维码有分为全覆盖背景模式(二维码全覆盖在背景图上),填充模式(在背景图的坐标(startX, startY)处绘制二维码(左上角坐标为0,0),背景渲染方式(用背景图来填充二维码)</li>
</ul>
<hr />
<h3>接口调用说明</h3>
<h4>请求方式</h4>
<p>如接口没有单独说明,所有接口均为:<strong>POST</strong></p>
<h4>请求格式</h4>
<p>如接口没有单独说明,所有接口均为:<strong>application/x-www-form-urlencoded</strong></p>
<h4>请求参数</h4>
<p>请求参数包括公共参数和业务参数(业务参数见具体接口说明)
调用接口时,需要把<strong>公共参数</strong>和<strong>业务参数</strong>一并放在<strong>请求参数</strong>中提交</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>签名,详见<a href="#签名算法">签名算法说明</a></td>
</tr>
</tbody>
</table>
<p><a name="签名算法"></a></p>
<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>
<p>所有接口公共返回码如下:</p>
<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>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>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>
<h4>接口描述</h4>
<ul>
<li>生成一个最常见的最普通的二维码</li>
</ul>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/qrcode/base</code></p>
<h4>业务参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>是</td>
<td>二维码信息</td>
</tr>
<tr>
<td>size</td>
<td>Integer</td>
<td>否</td>
<td>默认是200,建议大小为100-1000之间 小于100或大于1000按默认大小处理</td>
</tr>
</tbody>
</table>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,// 返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,// 返回码对应描述
&quot;taskNo&quot;: &quot;529509367177869193812664&quot;,// 本次请求号
&quot;charge&quot;: true,// 计费标志
&quot;data&quot;: {
&quot;base64&quot;: &quot;iVBORw0KGgoAAAANSUhEUgAAAfQAAAH0CAYAAADL1t+KAAAUUklEQVR42u3XwXEDMQwDQPXfdNyCXzEBLGb0P0skNnl/IiIiEpAAAElFTkSuQmCC&quot;,//base64
&quot;url&quot;: &quot;https://test-img2.jumdata.com/qrcode/20230820/3/4205454930.png&quot;,//图片url
&quot;picType&quot;: &quot;png&quot; //图片类型
}
}</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 999,
&quot;msg&quot;: &quot;生成二维码异常&quot;,
&quot;taskNo&quot;: &quot;487974114181909820820522&quot;,
&quot;charge&quot;: false
}</code></pre>
<h3>指定颜色的二维码</h3>
<h4>接口描述</h4>
<ul>
<li>默认的二维码为白底黑块,可以生成生指定颜色的二维码</li>
</ul>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/qrcode/color</code></p>
<h4>业务参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>是</td>
<td>二维码信息</td>
</tr>
<tr>
<td>size</td>
<td>Integer</td>
<td>否</td>
<td>默认是200,建议大小为100-1000之间 小于100或大于1000按默认大小处理</td>
</tr>
<tr>
<td>detectOutColor</td>
<td>String</td>
<td>否</td>
<td>定位点(探测图形)外边颜色,rgb的值 例如:#000000 可以不带#</td>
</tr>
<tr>
<td>detectInColor</td>
<td>String</td>
<td>否</td>
<td>定位点内部颜色,rgb的值 例如:#000000 可以不带#</td>
</tr>
<tr>
<td>drawPreColor</td>
<td>String</td>
<td>否</td>
<td>二维码着色点,rgb的值 例如:#000000 可以不带#</td>
</tr>
<tr>
<td>drawBgColor</td>
<td>String</td>
<td>否</td>
<td>二维码背景图颜色,rgb的值 例如:#000000 可以不带#</td>
</tr>
</tbody>
</table>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,// 返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,// 返回码对应描述
&quot;taskNo&quot;: &quot;473668886183453243714685&quot;,// 本次请求号
&quot;charge&quot;: true,// 计费标志
&quot;data&quot;: {
&quot;base64&quot;: &quot;iVBORw0KGgoAAAANSUhEUgAAAfQAAAH0CAYAAADL1t+KAAAT30lEQVR42u&quot;,//base64
&quot;url&quot;: &quot;https://test-img2.jumdata.com/qrcode/20230820/3/7135934491.png&quot;,//图片url
&quot;picType&quot;: &quot;png&quot;//图片类型
}
}</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 999,
&quot;msg&quot;: &quot;生成二维码异常&quot;,
&quot;taskNo&quot;: &quot;487974114181909820820522&quot;,
&quot;charge&quot;: false
}</code></pre>
<h3>带logo二维码</h3>
<h4>接口描述</h4>
<ul>
<li>支持带logo二维码的生成</li>
</ul>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/qrcode/logo</code></p>
<h4>业务参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>是</td>
<td>二维码信息</td>
</tr>
<tr>
<td>size</td>
<td>Integer</td>
<td>否</td>
<td>默认是200,建议大小为100-1000之间 小于100或大于1000按默认大小处理</td>
</tr>
<tr>
<td>file</td>
<td>File</td>
<td>否</td>
<td>logo图片,文件类型,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>base64</td>
<td>String</td>
<td>否</td>
<td>图片base64串,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>图片url,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>logoBorder</td>
<td>boolean</td>
<td>否</td>
<td>true表示logo有边框 false表示logo无边框 默认是true</td>
</tr>
<tr>
<td>logoStyle</td>
<td>String</td>
<td>否</td>
<td>logo样式 ROUND-圆角,NORMAL-普通,CIRCLE-圆,默认NORMAL</td>
</tr>
<tr>
<td>logoBgColor</td>
<td>String</td>
<td>否</td>
<td>logo背景颜色,rgb的值 例如:#000000 可以不带#</td>
</tr>
<tr>
<td>logoBorderBgColor</td>
<td>String</td>
<td>否</td>
<td>logo边框颜色,rgb的值 例如:#000000 可以不带#</td>
</tr>
<tr>
<td>drawPreColor</td>
<td>String</td>
<td>否</td>
<td>二维码着色点,rgb的值 例如:#000000 可以不带#</td>
</tr>
<tr>
<td>drawBgColor</td>
<td>String</td>
<td>否</td>
<td>二维码背景图颜色,rgb的值 例如:#000000 可以不带#</td>
</tr>
</tbody>
</table>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,// 返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,// 返回码对应描述
&quot;taskNo&quot;: &quot;586297583172190375725720&quot;,// 本次请求号
&quot;charge&quot;: true, // 计费标志
&quot;data&quot;: {
&quot;base64&quot;: &quot;iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAiw0&quot;,//base64
&quot;url&quot;: &quot;https://test-img2.jumdata.com/qrcode/20230820/3/6894151891.png&quot;,//图片url
&quot;picType&quot;: &quot;png&quot;//图片类型
}
}</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,
&quot;msg&quot;: &quot;logo图片不能为空&quot;
}</code></pre>
<hr />
<h3>指定背景图二维码-全覆盖的背景模式(支持gif动态图)</h3>
<h4>接口描述</h4>
<ul>
<li>二维码全覆盖在背景图上</li>
</ul>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/qrcode/background/override</code></p>
<h4>业务参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>是</td>
<td>二维码信息</td>
</tr>
<tr>
<td>size</td>
<td>Integer</td>
<td>否</td>
<td>默认是200,建议大小为100-1000之间 小于100或大于1000按默认大小处理</td>
</tr>
<tr>
<td>file</td>
<td>File</td>
<td>否</td>
<td>logo图片,文件类型,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>base64</td>
<td>String</td>
<td>否</td>
<td>图片base64串,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>图片url,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>bgOpacity</td>
<td>Float</td>
<td>否</td>
<td>二维码的透明度,值为0-1之间 默认是0.6f</td>
</tr>
<tr>
<td>level</td>
<td>String</td>
<td>否</td>
<td>纠错级别,[ L、M、Q、H ] 默认是H</td>
</tr>
</tbody>
</table>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,// 返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,// 返回码对应描述
&quot;taskNo&quot;: &quot;846405966146179538724947&quot;,// 本次请求号
&quot;charge&quot;: true, // 计费标志
&quot;data&quot;: {
&quot;base64&quot;: &quot;iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAiw0&quot;,//base64
&quot;url&quot;: &quot;https://test-img2.jumdata.com/qrcode/20230820/3/5719721246.gif&quot;,//图片url
&quot;picType&quot;: &quot;gif&quot;//图片类型
}
}</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,
&quot;msg&quot;: &quot;背景图片不能为空&quot;
}</code></pre>
<hr />
<h3>指定背景图二维码-填充模式(支持gif动态图)</h3>
<h4>接口描述</h4>
<ul>
<li>在背景图的坐标(startX, startY)处绘制二维码(左上角坐标为0,0)</li>
</ul>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/qrcode/background/fill</code></p>
<h4>业务参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>是</td>
<td>二维码信息</td>
</tr>
<tr>
<td>size</td>
<td>Integer</td>
<td>否</td>
<td>默认是200,建议大小为100-1000之间 小于100或大于1000按默认大小处理</td>
</tr>
<tr>
<td>file</td>
<td>File</td>
<td>否</td>
<td>logo图片,文件类型,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>base64</td>
<td>String</td>
<td>否</td>
<td>图片base64串,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>图片url,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>level</td>
<td>String</td>
<td>否</td>
<td>纠错级别,[ L、M、Q、H ] 默认是H</td>
</tr>
<tr>
<td>bgWidth</td>
<td>String</td>
<td>否</td>
<td>背景图片宽度 默认:500</td>
</tr>
<tr>
<td>bgHeight</td>
<td>String</td>
<td>否</td>
<td>背景图片宽度高度 默认:500</td>
</tr>
<tr>
<td>startX</td>
<td>String</td>
<td>否</td>
<td>二维码的绘制在背景图上的x坐标 默认:130</td>
</tr>
<tr>
<td>startY</td>
<td>String</td>
<td>否</td>
<td>二维码的绘制在背景图上的y坐标 默认是:120</td>
</tr>
<tr>
<td>padding</td>
<td>String</td>
<td>否</td>
<td>边框 0 - 4 (0表示无边框)</td>
</tr>
<tr>
<td>drawBgColor</td>
<td>String</td>
<td>否</td>
<td>二维码背景图颜色,rgb的值 例如:#000000 可以不带#</td>
</tr>
</tbody>
</table>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,// 返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,// 返回码对应描述
&quot;taskNo&quot;: &quot;488018177182018276118552&quot;,// 本次请求号
&quot;charge&quot;: true, // 计费标志
&quot;data&quot;: {
&quot;base64&quot;: &quot;iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAiw0&quot;,//base64
&quot;url&quot;: &quot;https://test-img2.jumdata.com/qrcode/20230820/3/3146700226.png&quot;,//图片url
&quot;picType&quot;: &quot;png&quot;//图片类型
}
}</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,
&quot;msg&quot;: &quot;背景图片不能为空&quot;
}</code></pre>
<hr />
<h3>指定背景图二维码-背景渲染方式(支持gif动态图)</h3>
<h4>接口描述</h4>
<ul>
<li>用背景图来填充二维码</li>
</ul>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/qrcode/background/penetrate</code></p>
<h4>业务参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>是</td>
<td>二维码信息</td>
</tr>
<tr>
<td>size</td>
<td>Integer</td>
<td>否</td>
<td>默认是200,建议大小为100-1000之间 小于100或大于1000按默认大小处理</td>
</tr>
<tr>
<td>file</td>
<td>File</td>
<td>否</td>
<td>logo图片,文件类型,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>base64</td>
<td>String</td>
<td>否</td>
<td>图片base64串,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>图片url,file、image、url 必须提供一个</td>
</tr>
<tr>
<td>level</td>
<td>String</td>
<td>否</td>
<td>纠错级别,[ L、M、Q、H ] 默认是H</td>
</tr>
</tbody>
</table>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,// 返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,// 返回码对应描述
&quot;taskNo&quot;: &quot;217103901209109752014566&quot;,// 本次请求号
&quot;charge&quot;: true, // 计费标志
&quot;data&quot;: {
&quot;base64&quot;: &quot;iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAiw0&quot;,//base64
&quot;url&quot;: &quot;https://test-img2.jumdata.com/qrcode/20230820/3/8333878961.png&quot;,//图片url
&quot;picType&quot;: &quot;png&quot;//图片类型
}
}</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,
&quot;msg&quot;: &quot;背景图片不能为空&quot;
}</code></pre>