SPIRAL ver.2の主要機能であるアカウント管理の中でも APIエージェント をピックアップしてお伝えします。
変更・改訂履歴
-
改訂
記事フォーマットの変更
- SPIRAL ver.2 概要
- 【アプリ管理】アプリ
- 【アプリ管理】DB
- 【アプリ管理】DBトリガ レコードアクション
- 【アプリ管理】DBトリガ 非同期アクション メールアクション
- 【アプリ管理】DBトリガ 非同期アクション カスタムプログラムアクション
- 【アプリ管理】スケジュールトリガ メールアクション
- 【アプリ管理】スケジュールトリガ カスタムプログラムアクション
- 【アプリ管理】アプリロール、アプリ利用画面
- 【サイト管理】サイト
- 【サイト管理】ページ
- 【サイト管理】フォームブロック
- 【サイト管理】フォームブロック ビジュアル設定
- 【サイト管理】フォームブロック ソース設定
- 【サイト管理】レコードリスト / レコードアイテム / レコード検索 ブロック
- 【サイト管理】フリーコンテンツブロック
- 【サイト管理】認証エリア
- 【アカウント管理】ユーザ
- 【アカウント管理】グループ
- 【アカウント管理】APIエージェント
動画
APIエージェント説明
APIエージェントとは
APIエージェントは、アカウント内で直接発行ができるAPIキーを扱う主体のことです。
APIエージェントのAPIキーは、主に外部システムからSPIRALへ連携する際に使用します。
また、APIエージェントはユーザと同じようにグループに含めることで各種操作権限を割り当てることができ、API操作のスコープをコントロールすることができます。
SPIRAL ver.2では権限設定をしたグループにAPIエージェントを含めることで、APIを使用することができるようになります。
すべての操作が行えるAPIは一見便利に見えますが、とても危険で取り扱いが難しくなります。
万が一、APIキーが漏洩してしまった場合、データの不正アクセスにつながります。
セキュリティ向上とAPIを安全にご使用いただくために、SPIRAL ver.2では権限設定を行ってAPIを使用する仕組みとなっております。
APIエージェントのAPIキーは、主に外部システムからSPIRALへ連携する際に使用します。
また、APIエージェントはユーザと同じようにグループに含めることで各種操作権限を割り当てることができ、API操作のスコープをコントロールすることができます。
SPIRAL ver.2では権限設定をしたグループにAPIエージェントを含めることで、APIを使用することができるようになります。
すべての操作が行えるAPIは一見便利に見えますが、とても危険で取り扱いが難しくなります。
万が一、APIキーが漏洩してしまった場合、データの不正アクセスにつながります。
セキュリティ向上とAPIを安全にご使用いただくために、SPIRAL ver.2では権限設定を行ってAPIを使用する仕組みとなっております。
APIエージェント作成
APIエージェント作成
APIエージェントメニューの＋ボタンから進み、表示名と識別名を入力して作成します。作成後に詳細設定を行いますので表示名をクリックします。
APIキー作成
表示名を入力して生成します。
作成画面を閉じると、APIキーを再度表示させることはできませんのでご注意ください。
作成画面を閉じると、APIキーを再度表示させることはできませんのでご注意ください。
ステータス
”無効”で生成されますので、使用する際には有効化ボタンから”有効”に変更します。
APIキー再⽣成
APIキーが分からなくなった場合は、再生成が可能です。
その場合、以前生成したAPIキーでのリクエストはエラーとなり、当該のAPIキーを使用したアプリケーションは動作しなくなります。
再生成して問題ないか、予めご確認ください。
その場合、以前生成したAPIキーでのリクエストはエラーとなり、当該のAPIキーを使用したアプリケーションは動作しなくなります。
再生成して問題ないか、予めご確認ください。
グループ
権限を最低限にする観点から、グループはAPIエージェント専用のものを作成し追加します。
使用するメソッドに合わせたアプリロールを作成し選択します。
使用するメソッドに合わせたアプリロールを作成し選択します。
APIエージェントグループ詳細設定
グループの詳細設定はグループメニューから行います。利用アプリ
API操作したいDBが存在するアプリを追加します。
ナレッジサイトに各メソッド使用時の安全なアプリロール権限設定を紹介しています。
詳細については、ナレッジサイトをご参照ください。
2023年2月7日（火）
APIメソッドごとのサンプルコード＆権限設定特集
サイト認証API
認証APIメソッドを使用したい認証エリアを追加します。
※APIエージェントを使用するアプリやサイトも制限したい場合は、管理アプリ・管理サイトも追加します。
参考リンク
最後に
SPIRAL ver.2ではAPIを使用するまでに少し設定していただく箇所がありますが、セキュリティ高くAPIを安全に使用した開発を行っていただきたいという思いがあります。
APIに対しても適切な権限を付与し、安心安全なアプリ開発を行ってください。
APIに対しても適切な権限を付与し、安心安全なアプリ開発を行ってください。
