APIアクセス制御管理
[管理者設定] > [APIアクセス制御管理]
SHIELDEX File の API アクセス制御管理機能は、チャンネルおよび業務単位で管理者ごとにアクセス権限を設定し、API呼び出し履歴を確認および管理できるように支援します。
管理者はチャンネルおよび業務コードに基づきAPIアクセス権限を細分化し、各権限ごとにAPIキーを発行したり、リクエストログを照会することができます。
⚠️「APIアクセス制御管理」の設定権限は [管理者タイプ - システム管理者] にあります。
管理者権限の設定は [管理者設定] > [アカウントおよび権限管理] にて可能です。
▷ コード登録
APIアクセス制御の基礎となる チャンネルコード
および 業務コード
を登録します。
チャンネル追加
+ チャンネル追加
ボタンをクリックすると、以下の項目を入力します。
項目 | 説明 |
---|---|
チャンネルコード | 固有識別コード(例:FRD、OPSなど) |
チャンネル名 | コードの説明または名称 |
チャンネルを削除すると関連するアクセス設定およびログがすべて削除され、復元できません。
業務追加
+ 業務追加
ボタンをクリックすると、以下の項目を入力します。
項目 | 説明 |
---|---|
業務コード | 業務区分用のコード |
業務名 | コードの説明(例:ファイル取り込み、ウイルス連携など) |
削除の注意
- 関連するアクセス制御設定が存在する場合、削除できません。
- 削除を確定すると、関連するすべてのデータが削除され、復元できません。
▷ アクセス制御設定
登録されたチャンネル/業務コードに対してAPIアクセス権限を付与する管理者を指定し、APIキーを発行・管理します。
アクセス制御登録
+ アクセス制御登録
ボタンをクリックすると、以下の項目を設定します。
項目 | 説明 |
---|---|
チャンネルコード | 登録済みのチャンネルコードから選択 |
業務コード | 登録済 みの業務コードから選択 |
担当チャンネル管理者 | アクセス権限を付与する管理者アカウント |
- 登録が完了すると、APIキーが自動的に生成され、一覧に表示されます。
表示項目
項目 | 説明 |
---|---|
登録日時 | アクセス権限が設定された日時 |
チャンネル/業務コード | 対象となる区分情報 |
管理者ID | 権限を持つ管理者アカウント |
APIキー | 認証に使用されるキー(外部漏洩に注意) |
処理 | アクセス制御を解除できるボタンを提供 |
管理者の変更
担当管理者の変更
ボタンをクリックすると、アクセス権限を持つ管理者を変更できます。
アクセス制御の解除
解除
ボタンをクリックすると、該当APIキーおよびアクセスポリシーが削除されます。
▷ アクセス制御ログ
APIを通じて行われたリクエスト履歴を照会できます。各リクエスト記録は詳細情報とともに提供され、フィルタおよびエクスポート機能をサポートします。
ログ項目
項目 | 説明 |
---|---|
API | リクエストの種類(照会、ダウンロードなど) |
顧客番号/ユーザー管理番号 | リクエスト元の識別子 |
チャンネルコード/業務コード | リクエストの区分情報 |
リクエスト作業ID | リクエスト追跡用の固有ID |
ファイル相対パス | 結果ファイルの保存パス |
ファイル名 | 処理されたファイルの名前 |
リクエスト日時/IP | リクエストが発生した日時およびクライアントIP |
応答メッセージ | JSON形式の処理結果 |
応答コード | HTTPステータスコード(例:200、403など) |
フィルター機能
- 日付範囲を指定して特定期間のログを照会できます。
- リクエストタイプフィルター(全体、申請、照会、ダウンロード、許可、ブロックなど)で分類表示可能です。
- 顧客番号、 ユーザー番号、チャンネルコード、業務コード、ファイル名など複数の条件でフィルタリング可能です。
エクスポート機能
- 左上の
エクスポート
ボタンをクリックすると、現在の照会条件に該当するログを CSVファイルとしてダウンロード できます。
CSVファイルは、監査ログの保管、レポート作成、システム連携エラーの追跡などに活用できます。
参考事項
- チャンネルおよび業務コードを活用して、組織内のAPIアクセス権限を体系的に分離します。
- APIキーは外部に漏洩しないように管理し、必要に応じてすぐに解除および再登録を行ってください。
- APIアクセスログは定期的にバックアップするか、エクスポート機能を活用して保管してください。