Skip to main content

Synchronous/Asynchronous Processing API Flow

00.integration_guide.mdBased on this, when integrating SHIELDEX File Disarmament (CDR)Asynchronous/SynchronousOrganizing the processing flow.

  • Asynchronous Flow: Declassification request → Status inquiry (or Callback) → Download
  • synchronous flow: Demilitarization Request → Download*(SHIELDEX server internally repeats status checks and responds with results upon completion)*

1. Asynchronous Processing Flow (Async)​

Asynchronous flow allows the server to register tasks in a queue andImmediately returns Job IDand the integrated system downloads it after checking the results later.

2. Synchronous Processing Flow (Sync)​

The synchronous processing flow refers to the case where the SHIELDEX server is configured to operate externally like a "synchronous API."
The server internally uses the existing asynchronous API(POST /v5/cdr, GET /v5/cdr/{jobID})Call to Selfat the completion pointDecontamination results onlyReturns.
The caller is included in the results.jobIDtoCall the download API separatelydoes.

3. Implementation Precautions​

  1. Status Check Interval: Calling the status check too frequently (e.g., immediate consecutive calls in a loop) can cause server load/blocking. (200ms interval recommended)
  2. Download Conditions: Status inquiry result is**code: 0(success)orcode: 1(Exception/Original Import)**You should only request a download in this case. (code: 2Blocking (download unavailable)
  3. Synchronous Processing TimeoutTo prevent infinite waiting when configuring the synchronous flow (server-side polling)Maximum Wait TimeandRetry Limitmust be placed.