二维码接口API & SDK使用教程

1. 获取 Bearer Token / API Key ： https://www.2weima.com/user/api_tokens/index.html
2. 下载SDK，复制SDK代码：https://www.2weima.com/static/api_sdk/api_sdk-1.2.5.zip
3. 完成

点击播放 - 先看视频，少走弯路：

后端使用 - 视频教程

前端使用 - 视频教程

下载SDK包已提供语言：Jquery、Node.js、PHP、Go、Python、C#、Java、Dart、Swift、Shell

Mock与接口文档：查看useMock接口文档

更新日志：
2022-01-17 解码增加 qr_base64 支持图片base64后上传解码（图片需要2M以内，建议先压缩后再base64）

二维码生成：

JSSDK

在你的网站中要显示二维码的位置上插入以下代码，自动显示当前网址的二维码。

<!-- 注意：删除 script 前空格 -->
<空格script type="text/javascript">
var _templateId = '490';//模板ID
var _apiKey='5|ciJvXPLTGboqFEnmymdMrmFqBMeSqFgkRMYLmzvM';// Bearer Token / API Key 注意替换为你自己的
var _qrContent='';//二维码内容，不输入自动获取当前网址
if(_qrContent==''){_qrContent = encodeURIComponent(document.location.href);}document.write('<img src="https://api.2weima.com/api/qrimage?qr_content='+ _qrContent +'&template_id='+_templateId+'&api_key='+_apiKey+'" alt="2weima.com api"/>');
</script>

PHP

//安装
composer require 2weima/open-api

//查看以下网页，见使用文档
https://packagist.org/packages/2weima/open-api
https://github.com/2weima/open-api

node.js Axios

//当使用模板 template_id 时，只需要传 qr_content 和 template_id 两个参数就可以了
var axios = require('axios');
var FormData = require('form-data');
var data = new FormData();
data.append('qr_content', 'test qr_content');
data.append('qr_size', '350');
data.append('qr_margin', '10');
data.append('qr_level', 'M');
data.append('qr_version', '0');
data.append('qr_shape', '0');
data.append('qr_mark_shape', '0');
data.append('template_id', '490');

var config = {
  method: 'post',
  url: 'https://api.2weima.com/api/qrencode',
  headers: { 
    'Accept': 'application/json', 
    'Authorization': 'Bearer 3|5bY28HQSW2Ada9eFyg1pTmoA2rSEgTBjNBuP074N', //注意替换为你自己的
    ...data.getHeaders()
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

二维码解码：

PHP

//安装
composer require 2weima/open-api

//查看以下网页，见使用文档
https://packagist.org/packages/2weima/open-api
https://github.com/2weima/open-api

node.js Axios

var axios = require('axios');
var FormData = require('form-data');
var data = new FormData();
data.append('qr_image', 'https://img.2weima.com/qr_template/2021/6/26/8857784941a0f2d2a024044f414c69f9.jpg');
data.append('qr_base64', 'data:image/jpg;base64,/9..省略...9k=');

var config = {
  method: 'post',
  url: 'https://api.2weima.com/api/qrdecode',
  headers: { 
    'Accept': 'application/json', 
    'Authorization': 'Bearer 3|5bY28HQSW2Ada9eFyg1pTmoA2rSEgTBjNBuP074N', //注意替换为你自己的
    ...data.getHeaders()
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

二维码接口参数详情说明

请查看useMock为我生成的文档：https://www.usemock.com/docs/61dd9d92e403d6df879a6841

响应状态说明：

注意：一图多码识别时，qr_content 是数组

{
"status": 200, 状态：{200 正常}，{ 400参数错误，422参数验证错误 429 Token错误 }，  {500处理失败}
"message": "success",//错误时返回错误处理
"qr_image": "https://img.2weima.com/qr_text/2021/9/11/07f1d0521a68c22c4c5f81f67f4c0ca0.png" //生成成功时返回二维码图片
//qr_multi = one 识别一个二维码
"qr_content": "二维码解码后内容" //解码成功时返回二维码内容
//qr_multi = multi 一图多码识别多个二维码
"qr_content":  [{
      "content": "一图多码识别时返回数组和位置",
      "format": "QRcode",
      "points": [{
          "x": "9.00",
          "y": "206.00"
        },
        {
          "x": "337.00",
          "y": "42.00"
        },
        {
          "x": "378.00",
          "y": "124.00"
        },
        {
          "x": "50.00",
          "y": "288.00"
        }
      ]
    }
  ],
}

//array points [ //坐标位置
//顺序 
0-------1
|       |
3-------2

接口请求限制

为防止恶意使用，限制每分钟请求量，以下限制足以满足80%以上企业使用，如有更高要求需要定制处理。

注意：

1. 共享接口API的并发量是浮动的，请求量大的时候系统会自动调节
2. 你在开发接口时不要一次性循环提交大量请求，应该适当sleep
3. 如果需要无限制请求，应该购买私有化部署，安装在你服务器中直接使用，了解详情：https://jie.2weima.com/local.html