Wigo を自社プロダクトに組み込む
メンバーが自社システム内でそのままウェブサイトを作成できます。ユーザーの作成、シングルサインオンでのログイン、サイトの作成・公開、変更時の webhook 受信が可能です。OpenAPI 3 仕様をダウンロードしてクライアントを生成できます。
クイックスタート(5分)
- パートナー登録(確認済みのメールアドレスが必要)— すぐにサンドボックスに入り、
wgk_test_…キーが発行されます(表示は一度だけなので必ず保存してください)。 - 呼び出しを試す:
curl https://trywigo.com/v1/ping \
-H "Authorization: Bearer wgk_test_xxxxxxxx"
- ユーザーを作成し、ログインリンクを取得して、ユーザーを Wigo に遷移させる:
# 1) create/update a member (idempotent by external_id)
curl -X PUT https://trywigo.com/v1/users/member-123 \
-H "Authorization: Bearer $WIGO_KEY" -H "Content-Type: application/json" \
-d '{"email":"[email protected]","name":"Nguyễn Văn A"}'
# 2) ONE-TIME login link (expires in 60 seconds)
curl -X POST https://trywigo.com/v1/users/member-123/login-links \
-H "Authorization: Bearer $WIGO_KEY" -H "Content-Type: application/json" \
-d '{"redirect":"/#/my-site"}'
# → {"url":"https://trywigo.com/sso/…","expires_in":60} — redirect the user's browser to this url
認証
すべての /v1/* リクエストにヘッダー Authorization: Bearer <key> を付けてください。リクエストは自社サーバーから送信します(キーをブラウザで動くコードに含めないでください)。Wigo はキーのハッシュのみを保存します。キーを紛失した場合はパートナーポータルで失効させて新しく作成してください(モードごとに最大5個)。レート制限:1キーあたり毎分120リクエスト。
サンドボックスと本番環境
Sandbox (wgk_test_…) | Production (wgk_live_…) | |
|---|---|---|
| 取得方法 | セルフ登録してすぐ利用可能 | 法人情報を入力 → 本番を申請 → Wigo 管理者が承認 → シートプランを購入 |
| ユーザーの権利 | 無料トライアルプランと同じ(サイト1つ、AIなし、バッジ表示 + noindex、自動クリーンアップ) | 対応する個人プラン(Basic/Professional)と同じ。ユーザーには支払いリマインダーは表示されません |
| クォータ | 最大50ユーザー | 購入したシート数に応じる |
2つのモードは完全に分離されています。テストキーから本番ユーザーは見えず、その逆も同様です。
ユーザー
PUT/v1/users/{external_id} — 作成または更新。ボディ:email(作成時は必須)、name、plan(basic|pro、本番のみ。既定では空きのある Professional シートを使用)。作成時は 201、ユーザーが既に存在する場合は 200 を返します。
GET/v1/users/{external_id} · DELETE/v1/users/{external_id}(パートナーからユーザーを削除:シートが解放され、権利が失効し、サイトは15/30/45日の失効ライフサイクルに入ります)· GET/v1/usage(ユーザー数とシート数)。
email_in_use)— パートナーが他人のアカウントを乗っ取ることはできません。API で新規作成されたユーザーは、初回アクセス時に Wigo の利用規約に同意する必要があります。シングルサインオン(SSO)
POST/v1/users/{external_id}/login-links — {"url", "expires_in":60} を返します。ユーザーを url にリダイレクトしてください。Wigo はリンクをログインセッションに交換し、redirect(/#/path 形式、既定は /#/my-site)へ遷移させます。リンクは1回限り有効で、60秒で失効します。再利用または失効したリンク ⇒ わかりやすい案内ページを表示します。パートナーの検証は API キー自体で行われます。
サイトと公開
| リクエスト | 説明 |
|---|---|
GET /v1/users/{external_id}/sites | ユーザーのサイト一覧を取得 |
POST /v1/users/{external_id}/sites | サイトを作成:{"name":"Quán A","template":"quan-ca-phe"}(template は省略可)。プランの上限に達した場合 ⇒ 409 site_limit |
POST /v1/sites/{id}/deploy | サイトを公開:{"subdomain":"quan-a"} ⇒ 202 {"job_id","version"}。サイトは https://quan-a.trywigo.com で稼働し、site.deployed webhook を受信します |
Webhooks
HTTPS アドレスをパートナーポータルまたは PUT /v1/webhook {"url":"https://…"} で設定します(署名シークレット whsec_… が返されます)。POST /v1/webhook/test でテストイベントを送信できます。内部ネットワークを指すアドレスは拒否されます。Wigo は JSON の POST を送信します:
{ "id": "evt-uuid", "type": "site.deployed", "created": "2026-10-30T03:00:00Z", "livemode": false,
"data": { "user": { "external_id": "member-123", "email": "[email protected]" },
"site": { "id": "…", "name": "Quán A", "subdomain": "quan-a", "url": "https://quan-a.trywigo.com", "version": 1 } } }
| イベント | 発生タイミング |
|---|---|
user.created · user.removed | API 経由でユーザーが作成/削除されたとき |
user.entitlement_changed | 権利が有効になった/無効になったとき(更新、シート不足、パートナーがサンドボックスに戻された場合) |
site.created · site.deployed · site.deleted | ユーザーがサイトを作成/公開/削除したとき |
webhook.test | 「テスト送信」をクリックしたとき |
署名の検証
ヘッダー X-Wigo-Signature: t=<unix>,v1=<hex>。ここで v1 = HMAC-SHA256(secret, "<t>." + <raw body>) です。署名は生のボディに対して検証し、t が5分以上ずれている場合はリクエストを拒否してください。
// Node.js
const crypto = require("crypto");
function verify(rawBody, header, secret) {
const [t, v1] = header.split(",").map((p) => p.split("=")[1]);
if (Math.abs(Date.now() / 1000 - Number(t)) > 300) return false;
const mac = crypto.createHmac("sha256", secret).update(`${t}.${rawBody}`).digest("hex");
return crypto.timingSafeEqual(Buffer.from(mac), Buffer.from(v1));
}
# Python
import hmac, hashlib, time
def verify(raw_body: bytes, header: str, secret: str) -> bool:
t, v1 = [p.split("=", 1)[1] for p in header.split(",")]
if abs(time.time() - int(t)) > 300: return False
mac = hmac.new(secret.encode(), f"{t}.".encode() + raw_body, hashlib.sha256).hexdigest()
return hmac.compare_digest(mac, v1)
<?php // PHP
function verify(string $raw, string $header, string $secret): bool {
[$t, $v1] = array_map(fn($p) => explode("=", $p, 2)[1], explode(",", $header));
if (abs(time() - (int)$t) > 300) return false;
return hash_equals(hash_hmac("sha256", "$t.$raw", $secret), $v1);
}
配信:受信確認として10秒以内に 2xx ステータスで応答してください。失敗した場合は 1分 → 5分 → 30分 → 2時間 → 12時間 後に再試行されます(初回を含め最大6回)。パートナーポータルでログを確認し、「再送信」をクリックできます。イベントは重複または順序が入れ替わって届くことがあるため、id で冪等に処理してください。
シートと権利(本番)
本番ユーザー1人につき 1シートを使用し、対応する個人プランと同じ権利が付与されます。シートはパートナーポータルで年単位で購入します(最低100シート、段階的割引)。シートが不足した場合 ⇒ 409 seat_limit。シートが失効した場合、またはパートナーがサンドボックスに戻された場合 ⇒ ユーザーは user.entitlement_changed webhook(active:false)を受信し、失効ライフサイクルに入ります(15日後に閲覧のみ、30日後にサイト停止、45日後にクリーンアップ)。サイトを維持するには、ユーザー自身で個人プランを購入できます。
エラーと制限
エラーは JSON {"error":"code","message":"…"} で返されます:
| HTTP | error | 意味 |
|---|---|---|
| 400 | bad_request, bad_url, bad_redirect | データが不正 |
| 401 | missing, invalid | キーがない/誤り/失効済み |
| 403 | suspended, not_live | パートナーが停止中 / 本番キーが未有効化 |
| 404 | not_found | ユーザー/サイトが見つからない(または他のパートナーのもの) |
| 409 | email_in_use, seat_limit, user_limit, site_limit, no_webhook | 競合 / クォータ超過 |
| 429 | — | 1キーあたり毎分120リクエスト超過 |
変更履歴
- v1(2026-10-30):リリース — ユーザー、SSO ログインリンク、サイト + 公開、HMAC 署名付き webhook、サンドボックス/本番、年単位のシート。
連携に関するサポートが必要な場合: [email protected].