📖 kw-platform-api マニュアル›ログインと API キー

▮▮ 2. ログインと API キー

ダッシュボードへのログインから、プログラム連携用 API キーの発行・管理までの手順です。
  1. ダッシュボードにログインする
  2. API キー（kwk_）を発行する
  3. キーを使ってリクエストする
  4. キーの安全な取り扱い
  5. ダッシュボードの使い方

2.1 ダッシュボードにログインする

  1. ブラウザでダッシュボード（トップページ https://<BASE_URL>/）を開きます
  2. kwtool の ID / パスワード（kwtool.co にログインするときと同じもの）を入力してログインします
ログインに5回失敗すると10分間ロックされます（kwtool 本体の仕様）。パスワードの入力にはご注意ください。

ログインすると、ブラウザでの操作用にアカウントに紐づくセッションが作られます。ダッシュボード上で API を試すだけなら、これ以上の準備は不要です。プログラム（GAS・Python・自社アプリ等）から使う場合は、次の API キーを発行してください。

2.2 API キー（kwk_）を発行する

プログラム連携には kwk_ で始まる API キーを使います。キーはダッシュボードから自分で発行・管理します。

  1. ダッシュボードのメニューから「API キー」を開きます
  2. 有効期限（任意。省略で無期限）を選んで「発行」を押します
  3. 発行されたキーはこの画面でしか表示されません。「キーをコピー」で控えて、安全な場所（環境変数・シークレット管理）に保管してください
状況説明
「API キーは未発行です。発行をご希望の方は…」と表示されるAPI 利用には管理者による利用許可が必要です。表示される案内に従ってサポートチーム（管理者）にお問い合わせください。許可が登録されると、この画面から自分で発行できるようになります
すでに有効なキーがある状態で再発行したローテーションになります。同じ条件で新しいキーが発行され、古いキーは即時失効します。プログラム側のキーを差し替えてください
キーをなくした / 漏らしたかもしれない再発行（ローテーション）すれば古いキーは無効になります。急ぎの失効は管理者に連絡してください（即時反映されます）

キーには利用プランに応じたスコープ（アクセス範囲）・レート制限・月間上限が設定されています。上限に達したときの挙動は「5. 料金・トラブル」を参照してください。

2.3 キーを使ってリクエストする

すべてのリクエストで、HTTP ヘッダー X-API-Key にキーを入れます。データ取得の URL は /v1/query の1本で、resource パラメータで内容を切り替えます（→ 3. API リファレンス）。

curl -H "X-API-Key: kwk_あなたのキー" "https://<BASE_URL>/v1/query?resource=calendar.latestWeek"
# → {"weekEnd": "2026-07-04"}  が返れば準備完了です

ヘッダーを付けられない環境（スプレッドシートの IMPORTDATA 等）に限り、クエリパラメータ ?key=kwk_... でも認証できます。ただし URL にキーが残るため、ヘッダー方式を推奨します（→ シート連携での注意）。

2.4 キーの安全な取り扱い

2.5 ダッシュボードの使い方

ダッシュボード（トップページ）では、コードを書かずに API を試せます。

← 1. はじめに 3. API リファレンス →

問い合わせ: kw-platform-api 管理者まで。 ← ダッシュボードへ戻る

▲ 先頭へ