ForHosting KIT · 開発者向けツール

WPA・WEP・オープン用WiFi QRペイロードを作成

WiFi QRペイロードはQRコード内に符号化されるテキストで、利用者が手入力しなくても端末がネットワーク認証情報を認識できるようにします。このツールは、SSID、パスワード、選択した暗号化方式から標準ペイロードを作成します。WPA、WEP、オープンネットワークに対応し、形式上特別な意味を持つ文字をエスケープして、任意のQRエンコーダーで使えるテキストを返します。結果は決定的で確認しやすく、APIでは1リクエスト$0.002で利用できます。

● Beta無料・ブラウザ内で実行

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

端末に必要なネットワーク情報を入力します

まず、無線アクセスポイントに表示されるSSIDを正確に入力してください。ネットワーク名では大文字と小文字が区別されるため、文字、空白、句読点を端末の表示と一致させる必要があります。次にパスワードを入力し、暗号化方式としてWPA、WEP、noneのいずれかを選択します。WPAは、この広く対応しているQRテキスト規約で表現される一般的なWPA、WPA2、WPA3パーソナル設定に適しています。WEPは古い機器向けに残され、noneはパスワードを要求しないネットワークを表します。暗号化方式の表記では大文字と小文字を区別しませんが、指定できるのはこの3種類だけです。それ以外を拒否することで、入力ミスから誤解を招くペイロードが生成されるのを防ぎます。WPAとWEPでは空でないパスワードが必要です。オープンネットワークではパスワードを無視し、パスワードフィールドも出力しません。そのため、結果にはスキャナーが実際に必要とする情報だけが含まれ、不要なパスワードが誤って埋め込まれません。

ペイロードとエスケープ規則を理解します

返される値はWIFI:で始まり、セミコロンで区切られたラベル付きフィールドを含みます。Tフィールドは認証方式、SフィールドはSSIDを示し、暗号化ネットワークではパスワードを格納するPフィールドも追加されます。最後の2個のセミコロンでペイロードが終了します。オープンネットワークでは一般的な値nopassを使用し、Pを省略します。このテキスト形式では、通常の文字にも構造上の意味があります。バックスラッシュはエスケープを開始し、セミコロンはフィールドを終了し、コンマやコロンは対応パーサーで区切り文字として解釈される場合があります。SSIDまたはパスワード内にこれらの文字がある場合、ツールは先頭にバックスラッシュを付けます。Office:Guestのような名前や句読点を含むパスワードでは特に重要です。未処理の値を単純に連結すると、一見正しくてもスキャナーが誤ったフィールドに分割する可能性があります。出力はJSONテキストであり、画像の描画や認証情報の変更は行いません。

結果を安全に符号化、確認、共有します

返されたペイロードを変更せず、任意のテキストを受け取れるQRコードライブラリ、印刷サービス、ラベル作成工程、デザインアプリへ渡してください。設置環境に適した誤り訂正レベルと物理サイズを選び、配布前に複数の対象端末で完成したコードを確認します。ペイロードが有効でも、端末からアクセスポイントへ到達できること、パスワードが最新であること、各OSが古い暗号化方式をすべて扱えることまでは保証されません。パスワードを含む文字列は機密情報として扱い、公開ログ、分析イベント、ソースリポジトリ、サポート依頼へ記録せず、認証情報の変更時には印刷済みコードを廃棄してください。この機能はネットワークへ問い合わせず、接続確認も行いません。指定された暗号化方式の検証、形式依存文字のエスケープ、再利用可能なペイロードの組み立てだけを予測可能に実行します。この分離により、安定して試験しやすい認証情報の直列化を保ちながら、QRの描画方法を独立して変更できます。

活用例

ゲストネットワーク用カードを用意します

受付に印刷するQRコードの認証情報テキストを作成し、訪問者が長いパスワードを入力せずに接続できるようにします。

ルーター設定ラベルを自動化します

別サービスが端末ラベルを描画する前に、設定済みのSSIDとパスワードから一貫したペイロードを生成します。

句読点を安全に処理します

ネットワーク名やパスワードにセミコロン、コロン、コンマ、バックスラッシュがあっても有効なペイロードを作成します。

よくある質問

1回のリクエスト料金はいくらですか？

APIリクエスト1回の料金は$0.002です。

QRコード画像も作成しますか？

いいえ。QRエンコーダーに渡せる標準WiFiペイロード文字列を返します。

どの暗号化方式に対応していますか？

WPA、WEP、noneに対応します。それ以外を指定すると無効入力エラーになります。

オープンネットワークのパスワードはどうなりますか？

パスワードは無視され、生成されるnopassペイロードにパスワードフィールドは含まれません。

特殊文字はエスケープされますか？

はい。SSIDまたはパスワード内のバックスラッシュ、セミコロン、コンマ、コロンには先頭にバックスラッシュが付きます。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/enc/qr-wifi-payload

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/enc/qr-wifi-payload \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ssid":"Studio WiFi","password":"correct horse battery staple","encryption":"WPA"}'

const res = await fetch("https://api.kit.forhosting.com/enc/qr-wifi-payload", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "ssid": "Studio WiFi",
    "password": "correct horse battery staple",
    "encryption": "WPA"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/enc/qr-wifi-payload",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "ssid": "Studio WiFi",
    "password": "correct horse battery staple",
    "encryption": "WPA"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/enc/qr-wifi-payload", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"ssid":"Studio WiFi","password":"correct horse battery staple","encryption":"WPA"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"ssid":"Studio WiFi","password":"correct horse battery staple","encryption":"WPA"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/enc/qr-wifi-payload", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "ssid": "Studio WiFi",
  "password": "correct horse battery staple",
  "encryption": "WPA"
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "enc.qr_wifi_payload",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

KITの完全なドキュメントを見る →