Skip to main content

SHIELDEX File Integration Guide

This document explains the process of integrating the SHIELDEX File harmlessness system.
The integration method can be broadly categorized intoCallback 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​

Transfer files to the SHIELDEX server from the integration system to register a job and receive a Job ID.

Step 2. Check Results​

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

The server notifies the integrated 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 demilitarization is successfully completed.

2. Select Integration Method​

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

  • Advantages: There are no unnecessary query requests, and real-time performance is guaranteed.
  • conditionThere must be an API server on the integration system side that can receive results.

Type B: Polling Method​

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

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

3. Step-by-step Detailed Guide​

Step 1. Decontamination 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, 2Call the API periodically until it is done.

Step 3. File Download​

At the result verification stagecode: 0(success) orcode: 1Download the file in case of (exception/original import).

4. Precautions When Integrating​

  1. UTF-8 Encoding: The character set for all requests 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.