Wifi QR Code

Wi-Fi Wireless Network QR Code Generation
Generate a Wi-Fi QR code image for wireless network onboarding.

Method: POST
Path: /v1/wifi-qrcode
Demo: https://api.gugudata.io/v1/wifi-qrcode/demo
OpenAPI: https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

Request Parameters:

appkey (string, required): Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.

ssid (string, required): Wi-Fi network name encoded into the QR code.

password (string, required): Wi-Fi password encoded into the QR code.

authentication (string, required): Wi-Fi authentication mode encoded into the QR code.

ishiddenssid (string, required): Whether the Wi-Fi network is hidden.

isshowwifiicon (string, required): Whether the generated QR code should include the Wi-Fi icon overlay.

size (integer, optional): A positive integer specifying the pixel size of the QR code, default is 500 pixels

Response Fields:

url (string, required): CDN URL of the generated Wi-Fi QR code image. Validation failures may return a plain-text error message instead of the success payload.

HTTP Status Codes:

200: Request processed successfully. Some endpoints expose a separate application-level status field in the response body, such as dataStatus.statusCode.

400: Invalid request parameters or request format. Check required fields, data types, and request body format.

401: Missing or unknown application key. Provide a valid appkey with the request.

403: The application key is recognized but access is not allowed. The key may be expired, inactive, or not permitted for the requested API.

429: Request rate or trial usage limit exceeded. Reduce concurrency or retry after the limit window resets.

500: Internal service error. Retry later or contact support if the error persists.

503: Upstream service unavailable. Retry later; the requested upstream dependency is temporarily unavailable.

Business Status Codes:

100 Normal return: No additional remark.

101 Parameter error: No additional remark.

102 Request rate limited: No more than 100 requests per second allowed

103 Account in arrears: No additional remark.

104 APPKEY error: Check if the provided APPKEY matches the one obtained from the developer center

110 API response error: No additional remark.

Key Features:

Compatible with various wireless network protocols.

Supports hiding the Wi-Fi SSID.

Supports adding a Wi-Fi icon in the center of the QR code, making it more visually appealing.

Customizable QR code size.

Full support for HTTPS (TLS v1.0 / v1.1 / v1.2 / v1.3).

Fully compatible with Apple ATS.

Nationwide CDN deployment.

Ultra-fast API response, with multiple servers for load balancing.

Details:
https://gugudata.io/details/wifiqrcode

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request Code Samples

Responses