通用二维码生成 API 接口
Tags: gugudata, qrcode, api
Published: 2022-04-23 22:11:40

通用二维码生成 API 接口

提供通用的二维码生成接口。

# 1. 产品功能

- 支持分类字符生成；
- 直接返回存储在 CDN 中的二维码链接，可直接使用；
- 网址内容直接识别，生成网址类型的二维码，扫描后可直接跳转；
- 自定义二维码尺寸；
- 全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；
- 全面兼容 Apple ATS；
- 全国多节点 CDN 部署；
- 接口极速响应，多台服务器构建 API 接口负载均衡。

# 2. API 文档

**API 详情地址:** [https://www.gugudata.com/api/details/qrcode](https://www.gugudata.com/api/details/qrcode)

**接口请求地址:** [https://api.gugudata.com/barcode/qrcode](https://api.gugudata.com/barcode/qrcode)

**返回格式:** application/json; charset=utf-8

**请求方式:** GET

**请求协议:** HTTPS

**请求示例:** [https://api.gugudata.com/barcode/qrcode?appkey=YOUR_APPKEY&content=YOUR_VALUE&size=500](https://api.gugudata.com/barcode/qrcode?appkey=YOUR_APPKEY&content=YOUR_VALUE&size=500)

**接口测试:** [https://api.gugudata.com/barcode/qrcode/demo](https://api.gugudata.com/barcode/qrcode/demo)

# 3. 请求参数

| 参数名  | 参数类型 | 是否必须 |   默认值    |                  备注                   |
| :-----: | :------: | :------: | :---------: | :-------------------------------------: |
| appkey  |  string  |    是    | YOUR_APPKEY |           付费后获取的 APPKEY           |
| content |  string  |    是    | YOUR_VALUE  |      二维码内容，网址类型智能识别       |
|  size   |   int    |    否    |     500     | 正整数，二维码尺寸像素，默认为 500 像素 |

# 4. 返回参数

|            参数名            | 参数类型 |                 备注                 |
| :--------------------------: | :------: | :----------------------------------: |
|    DataStatus.StatusCode     |   int    |            接口返回状态码            |
| DataStatus.StatusDescription |  string  |           接口返回状态说明           |
| DataStatus.ResponseDateTime  |  string  |           接口数据返回时间           |
|  DataStatus.DataTotalCount   |   int    | 此条件下的总数据量，一般用于分页计算 |
|         Data.Content         |  string  |              二维码内容              |
|           Data.Url           |  string  |      生成的二维码 CDN URL 路径       |

# 5. 接口响应状态码

| 状态码 |        状态码解释        |                             备注                             |
| :----: | :----------------------: | :----------------------------------------------------------: |
|  100   |         正常返回         |              可通过判断此状态码断言接口正常返回              |
|   -1   |         请求失败         |                       请求处理请求失败                       |
|  501   |         参数错误         |          请检查您传递的参数个数以及参数类型是否匹配          |
|  502   |       请求频率受限       |                一般建议每秒请求不超过 100 次                 |
|  503   | APPKEY 权限超限/订单到期 |     请至开发者中心检查您的 APPKEY 是否到期或是否权限超限     |
|  504   |       APPKEY 错误        |        请检查传递的 APPKEY 是否为开发者中心获取到的值        |
|  505   |  请求的次数超出接口限制  | 请检查对应接口是否有请求次数限制以及您目前的接口请求剩余次数 |
|  900   |     接口内部响应错误     |     接口可用性为 99.999%，如获取到此状态码请邮件联系我们     |

# 6. 开发语言请求示例代码

示例代码包含的开发语言：C#, Go, Java, jQuery, Node.js, Objective-C, PHP, Python, Ruby, Swift 等，其他语言进行对应的 RESTful API 请求实现即可。

![code demo](https://image.devopen.club/20220312222920.png)

# 7. 常见问题 Q&A

- Q: 数据请求有缓存吗？

  A: 所有的数据都是直接返回的，部分周期性数据在更新周期内数据是缓存的。

- Q: 如何保证请求时 key 的安全性？

  A: 一般建议将对我们 API 的请求放置在您应用的后端服务中发起，您应用的所有前端请求都应该指向您自己的后端服务，这样的架构也更加地纯粹且易维护。

- Q: 接口可以用于哪些开发语言？

  A: 可以使用于所有可以进行网络请求的开发语言，用于您项目快速地进行数据构建。

- Q: 接口的性能可以保证吗？

  A: 接口后台架构和我们给企业提供的商业项目架构一致，您可以通过访问测试接口查看接口相关返回性能与信息。

-----

咕咕数据，专业的数据提供商，提供专业全面的数据接口、商业数据分析，让数据成为您的生产原料。

![image-20200716141435988](https://image.devopen.club/20200716141437.png)

咕咕数据基于我们七年来为企业客户提供的千亿级数据存储与性能优化、相关海量基础数据支撑，将合规的部分通用数据、通用功能抽象成产品级数据 API，大大满足了用户在产品开发过程中对基础数据的需求，同时降低了海量数据的存储与运维成本，以及复杂功能的技术门槛与人力开发成本。

除了我们已开放的分类数据与功能接口外，还有海量数据正在整理、清洗、整合、构建中，后期会开放更多的数据与云端功能接口 API 供用户使用。

# **目前已开放的数据接口 API**

- [[条码工具] 通用二维码生成](https://www.gugudata.com/api/details/qrcode)
- [[条码工具] Wi-Fi 无线网二维码生成](https://www.gugudata.com/api/details/wifiqrcode)
- [[条码工具] 通用条形码生成](https://www.gugudata.com/api/details/barcode)
- [[图像识别] 通用 OCR](https://www.gugudata.com/api/details/ocr)
- [[图像识别] HTML 转 PDF](https://www.gugudata.com/api/details/html2pdf)
- [[图像识别] HTML 转 Word](https://www.gugudata.com/api/details/html2word)
- [[区域/坐标] 全国大学高校基础信息](https://www.gugudata.com/api/details/college)
- [[区域/坐标] 地理坐标逆编码](https://www.gugudata.com/api/details/geodecode)
- [[区域/坐标] IP 地址定位](https://www.gugudata.com/api/details/iplocation)
- [[区域/坐标] 全国省市区街道区域信息](https://www.gugudata.com/api/details/chinaregions)
- [[区域/坐标] 地理坐标系转换](https://www.gugudata.com/api/details/coordinateconverter)
- [[元数据/字典] 历年高考省录取分数线](https://www.gugudata.com/api/details/ceeprovince)
- [[元数据/字典] 历年高考高校录取分数线](https://www.gugudata.com/api/details/ceecollegeline)
- [[元数据/字典] 历年高考专业录取分数线](https://www.gugudata.com/api/details/ceemajorline)
- [[新闻/资讯] 软件开发技术博文头条](https://www.gugudata.com/api/details/techblogs)
- [[新闻/资讯] 获取任意链接文章正文](https://www.gugudata.com/api/details/fetchcontent)
- [[新闻/资讯] 公众号头条文章](https://www.gugudata.com/api/details/wxarticle)
- [[新闻/资讯] 获取任意链接正文图片](https://www.gugudata.com/api/details/fetchcontentimages)
- [[新闻/资讯] 获取公众号文章封面](https://www.gugudata.com/api/details/wxarticlecover)
- [[新闻/资讯] 幽默笑话大全](https://www.gugudata.com/api/details/joke)
- [[短信/语音] 手机归属地查询](https://www.gugudata.com/api/details/mobileattribution)
- [[文字/文本] 中文文本分词](https://www.gugudata.com/api/details/segment)
- [[文字/文本] 中英文排版规范化](https://www.gugudata.com/api/details/formatarticle)
- [[文字/文本] 百万中国对联数据](https://www.gugudata.com/api/details/couplet)
- [[文字/文本] 国际标准书号 ISBN](https://www.gugudata.com/api/details/isbn)
- [[文字/文本] 简体繁体互转](https://www.gugudata.com/api/details/stconvert)
- [[文字/文本] 唐诗宋词大全](https://www.gugudata.com/api/details/chinesepoem)
- [[文字/文本] 关键字摘要智能提取](https://www.gugudata.com/api/details/nlpabstract)
- [[天气/空气质量] 全国天气预报信息](https://www.gugudata.com/api/details/weatherinfo)
- [[天气/空气质量] 全国实时空气质量指数](https://www.gugudata.com/api/details/airquality)
- [[网站工具] 获取任意站点标题与图标](https://www.gugudata.com/api/details/favicon)
- [[股票行情] 美股实时行情数据](https://www.gugudata.com/api/details/stockusrealtime)
- [[股票行情] 美股历史行情数据](https://www.gugudata.com/api/details/stockus)
- [[股票行情] 美股分时交易数据](https://www.gugudata.com/api/details/stockusperminute)
- [[股票行情] 美股历年基本财务数据](https://www.gugudata.com/api/details/usfundamental)
- [[股票行情] 港股实时行情数据](https://www.gugudata.com/api/details/stockhkrealtime)
- [[股票行情] 港股历史行情数据](https://www.gugudata.com/api/details/stockhk)
- [[股票行情] 港股分时交易数据](https://www.gugudata.com/api/details/stockhkperminute)
- [[股票行情] 港股历年三大财务报表](https://www.gugudata.com/api/details/hkannualreport)
- [[股票行情] A 股实时行情数据](https://www.gugudata.com/api/details/stockcnrealtime)
- [[股票行情] A 股历史行情数据](https://www.gugudata.com/api/details/stockcn)
- [[股票行情] A 股分时交易数据](https://www.gugudata.com/api/details/stockcnperminute)
- [[股票行情] A 股历年三大财务报表](https://www.gugudata.com/api/details/annualreport)
- [[股票行情] 中国股票指数数据](https://www.gugudata.com/api/details/stockcnrealtimeindex)
- [[股票行情] A 股个股信息查询](https://www.gugudata.com/api/details/fundamentalinfo)
- [[股票行情] A 股历年财务指标](https://www.gugudata.com/api/details/financialindicator)
- [[股票行情] 科创板历史行情数据](https://www.gugudata.com/api/details/stockkcb)
- [[股票行情] 美股粉单实时行情数据](https://www.gugudata.com/api/details/pinksheetsrealtime)
- [[股票行情] 分类美股实时行情数据](https://www.gugudata.com/api/details/usfamous)
- [[股票行情] 公募开放式基金实时数据](https://www.gugudata.com/api/details/fundopenrealtime)
- [[股票行情] 公募开放式基金历史数据](https://www.gugudata.com/api/details/fundopenrealtime)
- [[体育/比赛] 历年奥运比赛数据](https://www.gugudata.com/api/details/olympic)