通用二維碼生成 API 接口
提供通用的二維碼生成接口边篮。
1. 產(chǎn)品功能
支持分類(lèi)字符生成鸽凶；
直接返回存儲(chǔ)在 CDN 中的二維碼鏈接，可直接使用齿椅；
網(wǎng)址內(nèi)容直接識(shí)別琉挖，生成網(wǎng)址類(lèi)型的二維碼，掃描后可直接跳轉(zhuǎn)涣脚；
自定義二維碼尺寸示辈；
全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；
全面兼容 Apple ATS遣蚀；
全國(guó)多節(jié)點(diǎn) CDN 部署矾麻；
接口極速響應(yīng)，多臺(tái)服務(wù)器構(gòu)建 API 接口負(fù)載均衡芭梯。
2. API 文檔
API 詳情地址: https://www.gugudata.com/api/details/qrcode
接口請(qǐng)求地址: https://api.gugudata.com/barcode/qrcode
返回格式: application/json; charset=utf-8
請(qǐng)求方式: GET
請(qǐng)求協(xié)議: HTTPS
請(qǐng)求示例: https://api.gugudata.com/barcode/qrcode?appkey=YOUR_APPKEY&content=YOUR_VALUE&size=500
接口測(cè)試: https://api.gugudata.com/barcode/qrcode/demo
3. 請(qǐng)求參數(shù)
| 參數(shù)名 | 參數(shù)類(lèi)型 | 是否必須 | 默認(rèn)值 | 備注 |
|---|---|---|---|---|
| appkey | string | 是 | YOUR_APPKEY | 付費(fèi)后獲取的 APPKEY |
| content | string | 是 | YOUR_VALUE | 二維碼內(nèi)容险耀，網(wǎng)址類(lèi)型智能識(shí)別 |
| size | int | 否 | 500 | 正整數(shù)，二維碼尺寸像素玖喘，默認(rèn)為 500 像素 |
4. 返回參數(shù)
| 參數(shù)名 | 參數(shù)類(lèi)型 | 備注 |
|---|---|---|
| DataStatus.StatusCode | int | 接口返回狀態(tài)碼 |
| DataStatus.StatusDescription | string | 接口返回狀態(tài)說(shuō)明 |
| DataStatus.ResponseDateTime | string | 接口數(shù)據(jù)返回時(shí)間 |
| DataStatus.DataTotalCount | int | 此條件下的總數(shù)據(jù)量甩牺，一般用于分頁(yè)計(jì)算 |
| Data.Content | string | 二維碼內(nèi)容 |
| Data.Url | string | 生成的二維碼 CDN URL 路徑 |
5. 接口 HTTP 響應(yīng)標(biāo)準(zhǔn)狀態(tài)碼
| 狀態(tài)碼 | 狀態(tài)碼解釋 | 備注 |
|---|---|---|
| 200 | 接口正常響應(yīng) | 業(yè)務(wù)狀態(tài)碼參見(jiàn)下方 接口自定義狀態(tài)碼 |
| 403 | 請(qǐng)求頻率超限 | CDN 層通過(guò) IP 請(qǐng)求頻率智能判斷，一般的高頻請(qǐng)求不會(huì)觸發(fā)此狀態(tài)碼 |
6. 接口響應(yīng)狀態(tài)碼
| 狀態(tài)碼 | 狀態(tài)碼解釋 | 備注 |
|---|---|---|
| 100 | 正常返回 | 可通過(guò)判斷此狀態(tài)碼斷言接口正常返回 |
| -1 | 請(qǐng)求失敗 | 請(qǐng)求處理請(qǐng)求失敗 |
| 501 | 參數(shù)錯(cuò)誤 | 請(qǐng)檢查您傳遞的參數(shù)個(gè)數(shù)以及參數(shù)類(lèi)型是否匹配 |
| 502 | 請(qǐng)求頻率受限 | 一般建議每秒請(qǐng)求不超過(guò) 100 次 |
| 503 | APPKEY 權(quán)限超限/訂單到期 | 請(qǐng)至開(kāi)發(fā)者中心檢查您的 APPKEY 是否到期或是否權(quán)限超限 |
| 504 | APPKEY 錯(cuò)誤 | 請(qǐng)檢查傳遞的 APPKEY 是否為開(kāi)發(fā)者中心獲取到的值 |
| 505 | 請(qǐng)求的次數(shù)超出接口限制 | 請(qǐng)檢查對(duì)應(yīng)接口是否有請(qǐng)求次數(shù)限制以及您目前的接口請(qǐng)求剩余次數(shù) |
| 900 | 接口內(nèi)部響應(yīng)錯(cuò)誤 | 接口可用性為 99.999%累奈，如獲取到此狀態(tài)碼請(qǐng)郵件聯(lián)系我們 |
7. 開(kāi)發(fā)語(yǔ)言請(qǐng)求示例代碼
示例代碼包含的開(kāi)發(fā)語(yǔ)言：C#, Go, Java, jQuery, Node.js, Objective-C, PHP, Python, Ruby, Swift 等贬派，其他語(yǔ)言進(jìn)行對(duì)應(yīng)的 RESTful API 請(qǐng)求實(shí)現(xiàn)即可。
8. 常見(jiàn)問(wèn)題 Q&A
-
Q: 數(shù)據(jù)請(qǐng)求有緩存嗎澎媒？
A: 所有的數(shù)據(jù)都是直接返回的搞乏，部分周期性數(shù)據(jù)在更新周期內(nèi)數(shù)據(jù)是緩存的。
-
Q: 如何保證請(qǐng)求時(shí) key 的安全性旱幼？
A: 一般建議將對(duì)我們 API 的請(qǐng)求放置在您應(yīng)用的后端服務(wù)中發(fā)起查描，您應(yīng)用的所有前端請(qǐng)求都應(yīng)該指向您自己的后端服務(wù)，這樣的架構(gòu)也更加地純粹且易維護(hù)柏卤。
-
Q: 接口可以用于哪些開(kāi)發(fā)語(yǔ)言冬三？
A: 可以使用于所有可以進(jìn)行網(wǎng)絡(luò)請(qǐng)求的開(kāi)發(fā)語(yǔ)言，用于您項(xiàng)目快速地進(jìn)行數(shù)據(jù)構(gòu)建缘缚。
-
Q: 接口的性能可以保證嗎勾笆？
A: 接口后臺(tái)架構(gòu)和我們給企業(yè)提供的商業(yè)項(xiàng)目架構(gòu)一致，您可以通過(guò)訪(fǎng)問(wèn)測(cè)試接口查看接口相關(guān)返回性能與信息桥滨。
咕咕數(shù)據(jù)窝爪，專(zhuān)業(yè)的數(shù)據(jù)提供商弛车，提供專(zhuān)業(yè)全面的數(shù)據(jù)接口、商業(yè)數(shù)據(jù)分析蒲每，讓數(shù)據(jù)成為您的生產(chǎn)原料纷跛。
咕咕數(shù)據(jù)基于我們七年來(lái)為企業(yè)客戶(hù)提供的千億級(jí)數(shù)據(jù)存儲(chǔ)與性能優(yōu)化、相關(guān)海量基礎(chǔ)數(shù)據(jù)支撐邀杏，將合規(guī)的部分通用數(shù)據(jù)贫奠、通用功能抽象成產(chǎn)品級(jí)數(shù)據(jù) API，大大滿(mǎn)足了用戶(hù)在產(chǎn)品開(kāi)發(fā)過(guò)程中對(duì)基礎(chǔ)數(shù)據(jù)的需求望蜡，同時(shí)降低了海量數(shù)據(jù)的存儲(chǔ)與運(yùn)維成本唤崭，以及復(fù)雜功能的技術(shù)門(mén)檻與人力開(kāi)發(fā)成本。
除了我們已開(kāi)放的分類(lèi)數(shù)據(jù)與功能接口外脖律，還有海量數(shù)據(jù)正在整理谢肾、清洗、整合小泉、構(gòu)建中芦疏，后期會(huì)開(kāi)放更多的數(shù)據(jù)與云端功能接口 API 供用戶(hù)使用。
