Wi-Fi 无线网二维码生成

生成 Wi-Fi 连接二维码，支持加密类型、隐藏网络和图标选项
生成包含网络名称和连接信息的 Wi-Fi 二维码。
支持 WPA 加密类型的连接信息。
支持 WEP 加密类型的连接信息。
支持 NOPASS 无密码网络，密码可显式传空。
可标记隐藏的 Wi-Fi 网络。
可选择在二维码中央添加 Wi-Fi 图标。
支持中文网络名称，便于展示本地化网络信息。
按 Wi-Fi 二维码格式处理名称及密码中的特殊字符。
返回 PNG 图片链接，供访客说明和线下连接卡使用。
提供完整示例输入及二维码，方便核对连接信息。
二维码包含连接信息；扫描设备是否支持自动连接取决于设备。RequestParameter 展示实际业务输入，包括 Wi-Fi 密码，不包含 APPKEY。

当前接口契约

接口详情：https://www.gugudata.com/api/details/wifiqrcode

请求参数

参数	类型	必填	默认值	说明
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。

业务状态说明

业务状态码	业务状态码解释	备注
100	生成成功	HTTP 200
501	参数错误	HTTP 400
504	APPKEY 缺失或无效	HTTP 401
901	生成、存储失败或超时	HTTP 503

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

生成成功（业务码 100）。

Bodyapplication/json

示例

{
  "DataStatus": {
    "StatusCode": 0,
    "StatusDescription": "string",
    "ResponseDateTime": "string",
    "DataTotalCount": 0
  },
  "Data": {
    "Content": "string",
    "Url": "string"
  }
}

🟠400参数错误（业务码 501）。

🟠401APPKEY 缺失或无效（业务码 504）。

🔴503生成、存储失败或超时（业务码 901）。

当前接口契约#

请求参数#

正常响应字段#

业务状态说明#

请求参数

请求示例代码

返回响应

当前接口契约

请求参数

正常响应字段

业务状态说明