Skip to main content

SHIELDEX File Integration Guide

This document describes the process of integrating the SHIELDEX File Decontamination System.
The integration method is largelyCallback methodandPolling MethodSupports two things.

1. Overall Integration Process​

Decontamination integration isDecontamination Request → Check Results → Download FileIt will proceed in 3 steps.

Step 1. Decontamination Request​

In the integration system, files are sent to the SHIELDEX server to register a job, and a Job ID is issued.

Step 2. Check Results​

Check the completion status of the decontamination work. You can choose one of two methods.

The server notifies the integration system of the results upon completion of the task.

Type B: Status Check (Polling)​

The integration system periodically queries the server for status to confirm completion.

Step 3. File Download​

Download the file once the decontamination is successfully completed.

2. Select Integration Method​

When requesting decontaminationcallbackURLIf you include it, you will be notified of the results at the corresponding URL as soon as the processing is complete.

  • Advantages: There are no unnecessary query requests, and real-time performance is guaranteed.
  • condition: The integration system must have an API server capable of receiving results.

Type B: Polling Method​

After the decontamination request, periodicallyStatus Inquiry APIis a method to check the completion status by calling.

  • Advantages: It can be implemented without a separate receiving server in the integration system.
  • Caution: Too frequent requests (less than 200ms) can cause server load.

3. Step-by-step Detailed Guide​

Step 1. Declassification Request (Common)​

files and metadatamultipart/form-dataRegister the task by sending it to __PH_0__.

Step 2. Check Results​

A. Receiving Callback​

The JSON result arrives at the URL set upon request.

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

B. Status Check (Polling)​

Task completedcode: 0, 1, 2) Calls the API periodically until it becomes available.

Step 3. File Download​

Result Confirmation Stepcode: 0(success) orcode: 1If it is (exception/original import), download the file.

4. Precautions When Integrating​

  1. UTF-8 Encoding: All request character sets must comply with UTF-8.
  2. Download Timing: Status inquiry API response is**complete(code: 0, 1)**You should only request a download when in a state.