概要
APIキーは、サーバーサイドアプリケーションをAgentWallex APIで認証します。各キーはawx_プレフィックスで始まり、アカウントに紐付けられています。
APIキーの作成
ダッシュボードまたはREST API(JWT認証が必要)を通じてAPIキーを作成します:ダッシュボード経由
- AgentWallexダッシュボードにログインします。
- Settings > API Keys に移動します。
- Create API Key をクリックします。
- キーにわかりやすい名前を付けます(例:
production-backend、staging-ci)。 - キーをコピーして安全に保管します — 一度しか表示されません。
API経由
APIキーの一覧表示
APIキーのローテーション
1
新しいキーの作成
ダッシュボードまたはAPIで新しいAPIキーを作成します。
2
アプリケーションの更新
新しいキーをアプリケーションの環境変数にデプロイします。
3
新しいキーの動作確認
新しいキーでAPI呼び出しが成功することを確認します。
4
古いキーの削除
不正アクセスを防ぐために古いキーを削除します:
レート制限
APIレート制限はプランティアに依存します:
レート制限を超過すると、APIは
Retry-Afterヘッダー付きの429 Too Many Requestsレスポンスを返します:
レート制限はAPIキーごとに適用されます。より高い制限が必要な場合は、AgentWallexチームにお問い合わせいただくか、プランをアップグレードしてください。
ベストプラクティス
- 環境ごとに1つのキー — 開発、ステージング、本番で別々のキーを使用してください。
- キーにわかりやすい名前を付ける — 環境とサービス名を含めてください(例:
prod-payment-service)。 - 使用状況を監視する —
last_used_atを確認して、削除すべき未使用のキーを特定してください。 - キーを共有しない — 各チームメンバーやサービスには独自のキーを用意してください。
- シークレットマネージャーを使用する — ディスク上の
.envファイルではなく、AWS Secrets Manager、HashiCorp Vault、または同様のツールにキーを保存してください。