メインコンテンツまでスキップ

SHIELDEXファイル連携ガイド

SHIELDEXファイル無害化システムと連動するプロセスを説明します。
連携方式は大きくコールバック方式とポーリング方式二つをサポートします。

1. 全体連携プロセス​

無害化連動は無害化リクエスト → 結果確認 → ファイルダウンロード3段階で進行します。

Step 1. 無害化リクエスト​

連動システムからSHIELDEXサーバーにファイルを転送して作業を登録し、Job IDを発行されます。

Step 2. 結果確認​

無害化作業の完了状況を確認します。二つの方法のうちの一つを選択できます。

Type A: コールバック受信 (推奨)​

サーバーが作業完了時に連携システムに結果を通知します。

Type B: 状態照会 (Polling)​

連動システムが定期的にサーバーに状態を照会して完了を確認します。

Step 3. ファイルのダウンロード​

無害化が成功裏に完了したら、ファイルをダウンロードします。

2. 連携方式の選択​

Type A: コールバック方式 (推奨)​

無害化リクエスト時callbackURLを含めて送信すると、処理が完了次第、該当のURLに結果を通知される方式です。

  • 利点: 不要な照会リクエストがなく、リアルタイム性が保証されます。
  • 条件: 連動システム側に結果を受信できるAPIサーバーが必要です。

タイプB: ポーリング方式​

無害化リクエスト後、定期的に状態照会APIを呼び出して完了状況を確認する方法です。

  • 利点: 連動システムに別途受信サーバーがなくても実装可能です。
  • 注意: あまりにも頻繁なリクエスト（200ms未満）は、サーバーに負荷をかける可能性があります。

3. ステップバイステップの詳細ガイド​

Step 1. 無害化リクエスト (共通)​

ファイルとメタデータをmultipart/form-dataに送信して作業を登録します。

Step 2. 結果確認​

A. コールバック受信​

リクエスト時に設定したURLにJSON結果が届きます。

{
    "jobID": "test-job-001",
    "code": 0,
    "msg": "success",
    "logReason": 200000,
    "logReasonMsg": "파일 재구성 완료"
}

B. 状態照会 (Polling)​

作業が完了(code: 0, 1, 2)になるまでAPIを定期的に呼び出します。

Step 3. ファイルのダウンロード​

結果確認段階でcode: 0(成功) またはcode: 1(例外/原本搬入)の場合、ファイルをダウンロードします。

4. 連携時の注意事項​

  1. UTF-8 エンコーディング: すべてのリクエストの文字セットはUTF-8に準拠する必要があります。
  2. ダウンロード時点: ステータス照会APIの応答が**完了(code: 0, 1)**状態の時にのみダウンロードを要求する必要があります。