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

SHIELDEX 連携ガイド

SHIELDEX File 無害化システムと連動するプロセスを説明します。

連携方式は大きくコールバック方式とポーリング方式二つをサポートします。

1. 全体連携プロセス​

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

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 0. API Key 発行 (事前準備)​

無害化APIを呼び出すには、まず連携システムを登録し、API Keyを発行してもらう必要があります。

  1. ウェブコンソール →ポリシー → 連携システムポリシー → 連動システム登録
  2. 連携システム名、ラベルを入力して登録するとAPIキーが自動発行されますなります。
  3. (選択)許可されたIPを登録すると、そのIPからのみリクエストが可能です。
  4. 発行されたAPIキーはすべての無害化API呼び出し時にAuthorization: Bearer <API-KEY>ヘッダーに含まれます。

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

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

API キーをAuthorization: Bearerヘッダーに含めて連携システムを識別します。

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. 連携時の注意事項​

  • UTF-8 エンコーディング: すべてのリクエストの文字セットはUTF-8に準拠する必要があります。
  • ダウンロード時点: ステータス確認 API レスポンスが完了(code: 0, 1**)**状態の時だけダウンロードをリクエストする必要があります。