WiFi QR Code Generation API Documentation

Wi-Fi Wireless Network QR Code Generation API
Category: QR Code & Barcode
Endpoint: POST https://api.gugudata.io/v1/wifi-qrcode?appkey={{appkey}}
Description: API for generating Wi-Fi wireless network QR codes
Overview
The Wi-Fi Wireless Network QR Code Generation API by GuGuData creates scannable QR codes that automatically configure Wi-Fi settings. By embedding the SSID, password, and encryption type within the code, users can connect to your Wi-Fi network instantly—no manual input of credentials required. This API also supports hidden SSIDs and can embed a Wi-Fi icon in the QR code for a more polished look.
Key highlights:
- Supports multiple encryption types (WEP, WPA, NOPASS).
- Hidden SSIDs – Indicate whether the network name is hidden.
- Optional Wi-Fi icon in the QR code center.
- Size customization – Generate codes up to 500px or more.
- HTTPS/TLS – End-to-end encryption, Apple ATS-compliant.
Demo URL
https://api.gugudata.io/v1/wifi-qrcode/demo
Request Parameters
Make a POST request to the endpoint, passing the parameters as JSON or form-data in the body:
| Parameter | Type | Required | Default Value | Description |
ssid | string | Yes | YOUR_VALUE | The Wi-Fi network SSID. |
password | string | Yes | YOUR_VALUE | The Wi-Fi network password. |
authentication | string | Yes | YOUR_VALUE | Encryption type: WEP, WPA, or NOPASS. |
ishiddenssid | string | Yes | YOUR_VALUE | Indicates if SSID is hidden: true or false. |
isshowwifiicon | string | Yes | YOUR_VALUE | Whether to add a Wi-Fi icon in the QR code center: true or false. |
size | int | No | 500 | Dimension of the QR code image in pixels (e.g., 600 for a 600×600 code). |
Example:
POST https://api.gugudata.io/v1/wifi-qrcode?appkey=YOUR_APPKEY
Request Body (JSON): { "ssid": "MyWiFiNetwork", "password": "password123", "authentication": "WPA", "ishiddenssid": "false", "isshowwifiicon": "true", "size": 600 }
Response Parameters
The API responds with JSON containing a status object and a URL for the generated QR code image. Key fields include:
| Parameter | Type | Required | Description |
DataStatus.StatusCode | int | Yes | The API response status code. |
DataStatus.StatusDescription | string | Yes | Brief explanation of the status. |
DataStatus.ResponseDateTime | string | Yes | Timestamp when the response was generated. |
DataStatus.DataTotalCount | int | Yes | Typically 1, indicating one QR code resource. |
Data.Content | string | Yes | Reflects the Wi-Fi SSID passed in the request. |
Data.Url | string | Yes | A CDN link to download or display the generated Wi-Fi QR code image. |
Error Codes
Below are some common error codes and reasons:
| Error Code | Error Content | Notes |
100 | Normal return | Request succeeded. |
101 | Parameter error | Required parameters are missing or malformed. |
102 | Request rate limited | Exceeded 100 requests per second limit. |
103 | Account in arrears | Payment or subscription issue; account not in good standing. |
104 | APPKEY error | Check your APPKEY for correctness/validity. |
110 | API response error | A generic error occurred on the server side. |
Features
- Various wireless protocols – Compatible with WEP, WPA, and open networks (
NOPASS). - Hidden SSID – Specify if the network name is broadcast or concealed.
- Wi-Fi icon overlay – Optionally place a distinctive Wi-Fi logo in the QR code center.
- Customizable size – Generate high-resolution QR codes for printing or display.
- Secure HTTPS – Full TLS v1.0–v1.3 support, aligned with Apple ATS.
- Nationwide CDN – Fast, reliable delivery of generated assets.
- Load balancing – High availability and rapid response time.
Additional Notes for Developers
- Use Cases: Ideal for cafes, hotels, or offices wanting instant Wi-Fi access for guests.
- Code Readability: Most smartphone camera apps can immediately recognize Wi-Fi configuration QR codes.
- Image Link: The returned
Data.Urlcan be embedded in email, websites, or apps for easy scanning.
Getting Started
- Sign up at GuGuData.io – Acquire your
appkey. - Construct a POST request – Include
ssid,password, and other parameters in JSON or form-data. - Check the JSON response – Retrieve
Data.Urlfor your Wi-Fi QR code image. - Integrate – Display the QR code or store its link wherever quick Wi-Fi access is needed.
About GuGuData
GuGuData is a leading data and API solutions provider, crafting specialized services for modern businesses and developers. Beyond this Wi-Fi QR code generator, we offer universal QR code APIs and barcode solutions. Our commitment to innovation and reliability ensures that developers can build robust, scalable applications with minimal overhead.
Key Highlights:
- Nine years in business – Extensive industry experience and proven solutions.
- 4.2k+ APIs – A continuously growing catalog, covering a wide array of use cases.
- 95% happy customers – Recognized for high performance and dedicated support.
Make use of the Wi-Fi Wireless Network QR Code Generation API to simplify the onboarding process for network users, making Wi-Fi sharing a hassle-free experience. Visit our official website to explore additional data-driven offerings from GuGuData.