API 文档
接口地址: https://api.gugudata.com/barcode/wifiqrcode
返回格式: application/json; charset=utf-8
请求方式: GET
请求协议: HTTPS
请求示例: https://api.gugudata.com/barcode/wifiqrcode?appkey=YOUR_APPKEY&ssid=wifi_name&password=123456&authentication=WPA&ishiddenssid=false&isshowwifiicon=true&size=200&cdn=
数据预览: https://www.gugudata.com/preview/wifiqrcode
接口测试: https://api.gugudata.com/barcode/wifiqrcode/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json
| 参数名 |
参数类型 |
是否必须 |
默认值 |
备注 |
| appkey |
string |
是 |
无 |
开发者中心分配的 APPKEY;支持现有 Query、Header 和 Bearer 鉴权。 |
| ssid |
string |
是 |
无 |
Wi-Fi 网络名称,必须显式传入,支持中文和特殊字符。 |
| password |
string |
是 |
无 |
Wi-Fi 密码,必须显式传入;NOPASS 可传空字符串。正式 RequestParameter 按实际请求返回密码,请妥善保管响应。 |
| authentication |
string |
是 |
无 |
加密类型支持 WPA、WEP、NOPASS;保留历史大小写及其他值归一化为 WPA 的行为。 |
| ishiddenssid |
string |
是 |
无 |
是否隐藏网络,必须显式传入;true、1、yes 表示是,其他历史值表示否。 |
| isshowwifiicon |
string |
是 |
无 |
是否显示 Wi-Fi 图标,必须显式传入;true、1、yes 表示是,其他历史值表示否。 |
| size |
integer |
否 |
500 |
默认 500;小于等于 0 或大于 500 按 500 处理,1–40 无法生成时明确报参数错误。保留既有尺寸换算,实际像素随内容变化,不保证等于此值。 |
| cdn |
string |
否 |
无 |
历史存储选项;不传使用默认图片地址,CLOUDFLARE 使用已有 Cloudflare 图片地址。 |
| 参数名 |
参数类型 |
备注 |
| DataStatus.StatusCode |
integer |
接口返回状态码 |
| DataStatus.StatusDescription |
string |
接口返回状态说明 |
| DataStatus.ResponseDateTime |
string |
接口数据返回时间 |
| DataStatus.DataTotalCount |
integer |
此条件下的总数据量,一般用于分页计算 |
| Data.Content |
string |
Wi-Fi SSID |
| Data.Url |
string |
生成的二维码 CDN URL 路径 |
| DataStatus.RequestParameter |
string |
实际业务输入,包括 Wi-Fi 密码;不包含 APPKEY。 |
{
"DataStatus": {
"StatusCode": 100,
"RequestParameter": "{\"ssid\":\"wifi_name\",\"password\":\"123456\",\"authentication\":\"WPA\",\"isHiddenSSID\":false,\"isShowWifiIcon\":true,\"size\":200,\"cdn\":\"\"}",
"StatusDescription": "生成成功",
"ResponseDateTime": "2026-10-07 14:11:01.526",
"DataTotalCount": 1
},
"Data": {
"Content": "SSID:wifi_name",
"Url": "https://static.gugudata.com/qrcode_52058549-f167-4fcf-959b-1990f1ed891f.png"
}
}