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