Skip to content

API アクセス

WallaWhats はダッシュボードが使うのと同じ操作を JSON HTTP API で公開します。サブスクリプション管理のスクリプト化、通知履歴を自分のシステムに取り込むこと、内部ツールにアラートを統合することに使えます。各有料ティアに API アクセスが含まれます — プランごとのキー上限は プランの管理 を参照。

ステップ 1 — API キー を開く

サイドバーで API キー(アクセスキー の下)をクリックします。

1 つのデフォルトキーがある API キーページ

ステップ 2 — キーを作成

  1. キーを作成 をクリック。
  2. キーに 名前(例: production-serverlocal-dev)を付けます。名前は単なるラベルで権限には影響しません。
  3. 作成 をクリック。

キーの完全な値は 一度だけ 表示されます — すぐにシークレットマネージャにコピーしてください。WallaWhats はハッシュと短いプレフィックス(bws_xxxxxxxx…)のみ保存するので、後で復元できません。

キーはパスワードのように扱う

キーを持つ誰もがアカウント上で行動できます。キーはシークレットマネージャに保管し、git にコミットせず、定期的にローテーションしてください。

ステップ 3 — キーを使用

すべてのリクエストで x-api-key ヘッダにキーを送信します:

bash
curl -H "x-api-key: bws_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  https://api.wallawhats.com/subscriptions

利用可能なエンドポイント、リクエストボディ、レスポンス形式は API リファレンス で文書化されています。

ステップ 4 — ローテーションまたは取り消し

  • ローテーション — 新しいキーを作成、デプロイし、古いキーを削除します。意図的に「ローテーション」ボタンはありません。作成して削除することでカットオーバーがアトミックになります。
  • 取り消し — キーの行の隣の 削除 をクリック。キーは即座に機能しなくなります。それを使用中のリクエストは 401 Unauthorized を返します。

プラン上限

プランAPI キー
Free1
Pro1
Pro+2
Business5
Enterprise20

上限に達した場合、キーを作成 は無効化されます — 古いキーを先に削除するかプランをアップグレードしてください。

次のステップ

リクエスト/レスポンスのスキーマと完全なエンドポイントリストは API リファレンス → を参照してください。

WallaWhats Documentation