ドキュメント
アプリを開く

API キー

API key は承認済み machine-to-machine 統合を認証します。組み込みの Configure Embed は browser 内で organization API key を使わず、publish/embed identity を制限付き guest session に交換します。Chat または組み込み widget だけを使う場合、その目的の key は作成しません。

1

API Keys を開く

左サイドバーの Console → 対象の組織 → API Keys に移動します。

公開鍵・スコープ・状態・最終利用・作成日とともに key を一覧する API Keys 画面
各 key にスコープと利用履歴の有無が表示されます。
2

キーを作成する

右上の「Create API Key」をクリックします。ダイアログが開くので、後から識別できるよう任意の名前(例:「Production environment」)を入力し、「Create」をクリックします。

名前を入力した Create API Key ダイアログ
名前は自分用のラベルで、key の権限には影響しません。
3

キーとシークレットを直ちに保存する

「API Key created」画面は一度しか表示されません。API Key(形式:sota_ek_…)と API Secret の両方が表示されるので、この時点で両方をコピーし、安全に保管してください。画面を閉じた後は再表示できません。

作成直後に一度だけ表示されるダイアログ。API key、マスクされた secret、再表示されない旨の警告
Secret は一度しか表示されません。閉じる前にコピーしてください。
4

確認して閉じる

保存が済んだら「I have saved the Secret」をクリックしてダイアログを閉じます。

5

API 呼び出しでキーを使用する

API key は承認済みの server-to-server 統合でのみ使用します。ブラウザーや public widget に secret を埋め込まないでください。主な用途は、自社システムに SotaAgents を組み込むための ticket handshake の署名です — 自社システムへの SotaAgents 組み込みを参照してください。

6

キーを無効化する

キーを削除せずに利用を停止するには、対象キーの行にある「Actions」ボタンから「Disable」を選択し、ダイアログで確認します。キーは直ちに無効になり、一覧には無効状態のまま表示されます。

キーは秘密情報として扱う

API キーをソース管理にコミットしたり、チャットで共有したりしないでください。パスワードと同様に扱います。キーが漏えいした場合は、直ちに無効化して新しいキーを作成してください。

目次

Esc

全章のタイトルと本文を検索します。