API features
Wi-Fi connection QR codes
Create a scannable code that helps supported devices join a wireless network.
Common security modes
Generate codes for WPA, WEP, or open networks.
Hidden network support
Include the hidden-network setting in the encoded Wi-Fi configuration.
Configurable PNG size
Choose the square image size that best fits print or digital placement.
Optional Wi-Fi symbol
Add a familiar Wi-Fi mark when the selected design calls for it.
Guest onboarding
Simplify network access in offices, events, rentals, and customer spaces.
API Document
HTTP Protocol:HTTPS
HTTP Method:POST
HTTP Endpoint:https://api.gugudata.io/v1/wifi-qrcode
Response Type:application/json; charset=utf-8
DEMO Endpoint:https://api.gugudata.io/v1/wifi-qrcode/demo
Live Demo:Try Interactive Demo
Postman Collection:Run in Postman
API Request Parameters
| Name | Type | Is Required | Default Value | Remark |
|---|---|---|---|---|
| appkey | string | true | YOUR_APPKEY | API key used to authenticate the request. |
| ssid | string | true | YOUR_VALUE | Wi-Fi network name encoded into the QR code. |
| password | string | true | YOUR_VALUE | Wi-Fi password encoded into the QR code. |
| authentication | string | true | YOUR_VALUE | Wi-Fi authentication mode encoded into the QR code. |
| ishiddenssid | string | true | YOUR_VALUE | Whether the Wi-Fi network is hidden. |
| isshowwifiicon | string | true | YOUR_VALUE | Whether the generated QR code should include the Wi-Fi icon overlay. |
| size | integer | false | 500 | A positive integer specifying the pixel size of the QR code, default is 500 pixels. |
API Response Parameters
| Name | Type | Remark |
|---|---|---|
| url | string | CDN URL of the generated Wi-Fi QR code image. Validation failures may return a plain-text error message instead of the success payload. |
API Response Status Codes
| Status Code | Explanation of Status Code | Remarks |
|---|---|---|
| 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 request frequency and retry with backoff. If a trial allowance is exhausted, check Trial Keys for remaining requests and subscribe to continue. |
| 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. |
Remote MCP
Use this API through GuGuData Remote MCP
Connect your AI client once, authorize in the browser, and the client can use the GuGuData API tools available to your account. You do not need to paste an appkey into the MCP client.
https://mcp.gugudata.io/mcp{
"mcpServers": {
"gugudata": {
"url": "https://mcp.gugudata.io/mcp",
"transportType": "streamable-http"
}
}
}Code Snippets
Frequently asked questions
Common questions about request limits, trials, renewal, and cancellation.
What does the 5 requests per second limit mean?
It is a request-rate limit, not a concurrency allowance. Keep your request rate at or below 5 per second. If the service returns a rate-limit response, reduce the frequency and retry with backoff.
Is total paid usage limited?
There is no total request cap during an active paid subscription and no usage-based overage charge.
How does the free trial work?
Each account can receive a limited trial key. Requests are shared across APIs in the same category. Check Trial Keys for the exact allowance and remaining requests.
How do renewal and cancellation work?
The plan renews annually until canceled. Manage or cancel the renewal from Dashboard → Orders & Billing. Access continues through the paid period after cancellation. See the Terms of Service for the current refund policy. If the billing portal is unavailable, contact support.
Service terms
Read our service terms and privacy policy before subscribing.



