Wi-Fi Wireless Network QR Code Generation LLM Markdown

Back to Details
# Wi-Fi Wireless Network QR Code Generation

Generate QR codes that connect devices to Wi-Fi networks.

## API Overview

- **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:** https://gugudata.io/demo/wifiqrcode
- **Postman:** https://www.postman.com/gugudata/gugudata-io
- **LLM Page:** https://gugudata.io/details/wifiqrcode/llm
- **Raw Markdown:** https://gugudata.io/details/wifiqrcode/llm.md

## Remote MCP

- **MCP Endpoint:** https://mcp.gugudata.io/mcp
- **MCP Guide:** https://gugudata.io/mcp/
- **Authorization:** OAuth authorization opens in the browser; do not paste appkeys into MCP clients.
- **Tool Scope:** MCP clients receive GuGuData API tools available to the authorized account.

## Data & 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 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. |

## cURL Example

```bash
curl --location 'https://api.gugudata.io/v1/wifi-qrcode?appkey=YOUR_APPKEY' --request POST --header 'Content-Type: application/json' --data '{
  "ssid": "YOUR_VALUE",
  "password": "YOUR_VALUE",
  "authentication": "YOUR_VALUE",
  "ishiddenssid": "YOUR_VALUE",
  "isshowwifiicon": "YOUR_VALUE",
  "size": 500
}'
```