API キー管理
RealBoard のシステム管理者向けのガイドです。
API キー
RealBoard のリソースを管理する WebAPI を呼び出すためのキーを発行できます。 キーの利用を停止したい場合は削除で無効化できます。
WebAPI の詳細は別途マニュアルを参照してください。
API キーの一覧画面
機能
- 登録済み API キーの一覧を確認できます。
アクセス方法
- システム管理者でログイン > 左サイドの「API Key」をクリック
APIキーの一覧画面
① API Key リスト
- 登録済み API キーの一覧です。
- テーブルの行をクリックすると編集画面に移動します。
| 項目 | 内容 |
|---|---|
| API Key Prefix | API キーの接頭辞 |
| 名前 | API キーの名前 |
| 登録日 | API キーの登録日 |
| 更新日 | API キーの更新日 |
API キーの新規作成画面
機能
- API キーを新規作成できます。
- 新規作成時にのみ API キーの中身を確認できます。
アクセス方法
- 一覧画面 > ヘッダの「新規作成」をクリック
手順 - API キーを新規作成する
- 新規作成画面を開く
- 「名前」に任意のテキストを入力（例：TestClient）
- 「登録」ボタンをクリック
- 「コピー」で API キーの中身をコピー。システム管理者側で保管する
- ダイアログを閉じる
APIキーの新規作成の流れ
API キーの編集画面
機能
- API キーの名前を変更できます。
- API キーを削除できます。
アクセス方法
- 一覧画面 > API キーの名前をクリック
手順 - API キーを削除する
- 編集画面を開く
- 「詳細設定」をクリック
- 「削除」ボタンをクリック
APIキーの削除の流れ