API ドキュメント
Quik.mn の REST API を使えば、リンクの作成・管理からアナリティクスの取得まで、すべてプログラムから行えます。
すべてのサービス
Quik.mn のすべての製品を、REST API とウェブの両方から。
ベース URL
すべてのエンドポイントは、次のベース URL から始まります：
認証
リクエストごとに、ダッシュボードで取得した API キーを Authorization ヘッダーに含めます：
キーは誰にも渡さないでください。漏れてしまった場合は、ダッシュボードから作り直せます。
エンドポイント一覧
パラメーター
POST /api/v1/links — body のフィールド：
GET /api/v1/links — query パラメーター：
エラー形式
エラーはすべて、HTTP のステータスコード（401、404、409、422、429）と、統一された JSON 構造で返ります：
{ "error": "alias_taken", "message": "このエイリアスは予約済みか、すでに使用されています。" }
主なコード： unauthorized (401), not_found (404), alias_taken (409), invalid_url / invalid_alias / invalid_expires_at / invalid_starts_at (422), rate_limited (429).
レート制限
リクエスト例
短縮リンクを作成する cURL の例：
curl -X POST https://quik.mn/api/v1/links \
-H "Authorization: Bearer qk_live_xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/とても/長い/パス",
"alias": "promo",
"title": "春キャンペーン",
"expires_at": "2026-12-31 23:59:59"
}'
Webhook
ダッシュボードのウェブフック欄でエンドポイントを登録すると、選んだイベントが起きるたびに、指定の URL へ JSON を POST します。2xx の応答が成功で、それ以外は1分→10分の間隔で最大3回まで再送します。10回続けて失敗した場合、ウェブフックは自動的に停止します。
各配信の構造（例）：
{
"event": "link.created",
"created_at": "2026-07-18T09:30:00+00:00",
"data": {
"link": {
"id": 42, "slug": "promo", "short_url": "https://quik.mn/promo",
"long_url": "https://example.com/とても/長い/パス", "title": "春キャンペーン",
"clicks": 0, "active": true, "state": "ok",
"created_at": "2026-07-18 09:30:00", "expires_at": "2027-07-18 09:30:00"
}
}
}
署名の検証
どの配信にも、次のヘッダーが付きます： X-Quik-Event (イベント名), X-Quik-Signature — sha256=HMAC_SHA256(body, secret). シークレットは、ウェブフックを作成したときに一度だけ表示されます。署名は必ず生の（raw）リクエストボディに対して、一定時間比較で検証してください：
<?php
// PHP — 生のリクエストボディ(raw body)で署名を検証
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_QUIK_SIGNATURE'] ?? '';
$expected = 'sha256=' . hash_hmac('sha256', $payload, $secret);
if (!hash_equals($expected, $signature)) {
http_response_code(401);
exit('invalid signature');
}
$event = json_decode($payload, true);
// $event['event'], $event['data'] ...
http_response_code(200);
// Node.js (Express) — 生のリクエストボディ(raw body)で署名を検証
const crypto = require('crypto');
app.post('/quik-webhook', express.raw({ type: 'application/json' }), (req, res) => {
const signature = req.get('X-Quik-Signature') || '';
const expected = 'sha256=' +
crypto.createHmac('sha256', secret).update(req.body).digest('hex');
const a = Buffer.from(expected), b = Buffer.from(signature);
if (a.length !== b.length || !crypto.timingSafeEqual(a, b)) {
return res.status(401).send('invalid signature');
}
const event = JSON.parse(req.body); // event.event, event.data ...
res.sendStatus(200);
});
上限：Free は1件、Pro は3件、Business は10件のウェブフックまで。エンドポイントは外部から到達できる http/https のアドレスである必要があります（内部ネットワークのアドレスは使えません）。
