# Wi-Fi 无线网二维码生成 API 接口


Wi-Fi 无线网二维码生成 API 接口

Wi-Fi 无线网二维码生成接口。

![gugudata_api_cover](https://static.gugudata.com/api_qrcode_wifi.png)

# 1. 产品功能

- 兼容多种无线网协议；
- 支持是否隐藏 Wi-Fi SSID；
- 支持是否在二维码中间添加 Wi-Fi 图标，更加美观；
- 自定义二维码尺寸；
- 全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；
- 全面兼容 Apple ATS；
- 全国多节点 CDN 部署；
- 接口极速响应，多台服务器构建 API 接口负载均衡。

# 2. API 文档

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

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

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

**请求方式:** GET

**请求协议:** HTTPS

**请求示例:** [https://api.gugudata.com/barcode/wifiqrcode?appkey=YOUR_APPKEY](https://api.gugudata.com/barcode/wifiqrcode?appkey=YOUR_APPKEY)
&ssid=YOUR_VALUE
&password=YOUR_VALUE
&authentication=YOUR_VALUE
&isHiddenSSID=YOUR_VALUE
&isShowWifiIcon=YOUR_VALUE
&size=500

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

# 3. 请求参数

|     参数名     | 参数类型 | 是否必须 |   默认值    |                       备注                        |
| :------------: | :------: | :------: | :---------: | :-----------------------------------------------: |
|     appkey     |  string  |    是    | YOUR_APPKEY |                付费后获取的 APPKEY                |
|      ssid      |  string  |    是    | YOUR_VALUE  |                    无线网 ssid                    |
|    password    |  string  |    是    | YOUR_VALUE  |                    无线网密码                     |
| authentication |  string  |    是    | YOUR_VALUE  |       无线网加密类型，可选 WEP、WPA、NOPASS       |
|  isHiddenSSID  |  string  |    是    | YOUR_VALUE  |         是否隐藏 SSID，可选值 true、false         |
| isShowWifiIcon |  string  |    是    | YOUR_VALUE  | 二维码中间是否添加 Wi-Fi 图标，可选值 true、false |
|      size      |   int    |    否    |     500     |      正整数，二维码尺寸像素，默认为 500 像素      |

# 4. 返回参数

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