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