APIキー

キーを作成できる人

APIキーはチーム管理者によって作成されます。認証されており、チームへの管理者アクセス権を持っている必要があります。各キーのスコープはチームに設定され、チームの権限を継承します。

APIキーの作成

[管理]、[チーム]、[APIキー] の順に移動します。 [APIキーの作成] をクリックし、わかりやすい名前を付けます (例: 「CRM sync」または「Analytics エクスポート」)。キーは作成時に一度表示されます。すぐにコピーします。

APIキーの使用

HTTP リクエストの Authorization ヘッダーに APIキーを Bearer トークンとして含めます。

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "受け入れる: application/json" \
     https://your-domain.test/api/v1/organizer/events

キー管理

APIキー セクションですべての APIキーを表示します。各キーには、その名前、最後の 4 文字のプレビュー (識別用)、作成日、最後に使用された日が表示されます。最後に使用されたタイムスタンプは、取り消しても安全な非アクティブなキーを識別するのに役立ちます。

キーの取り消し

キーが不要になった場合、またはキーが侵害された可能性がある場合は削除しないでください。取り消しはすぐに有効になります。そのキーを使用するすべてのリクエストは 401 Unauthorized 応答で失敗します。接続された統合は、新しいキーで更新されるまで動作を停止します。

セキュリティのベスト プラクティス

次のガイドラインに従って APIキーを安全に保ちます。

• キーは環境変数またはシークレット マネージャーに保存し、ソース コードには決して保存しないでください。
• キーを定期的にローテーションします。新しいキーを作成します。統合を更新してから古い統合を取り消します
• 他の統合に影響を与えずに統合を取り消すことができるように、異なる統合に個別のキーを使用します
• 最後に使用されたタイムスタンプを監視して予期しない使用を検出します
• チャット、電子メール、またはパブリック チャネルでキーを共有しないでください