Asynchronous API
While the Synchronous API effectively meets the need for handling substantial volumes of data, certain client architecture patterns will require the incorporation of an asynchronous mode.
With Glasswall Halo's Asynchronous API, requests can be handled via a two-stage process. Initially, a UUID is generated for a request, which can subsequently be used to retrieve the processing outcome. This enables the client to continue at its own convenience, eliminating the requirement to wait for file processing.
Accessing Asynchronous API
The Glasswall Asynchronous API can be accessed via:
Endpoints
The Glasswall Asynchronous API consists of several endpoints which carry out specific functions.
The endpoints and their descriptions are listed below.
CDR Async
This endpoint asynchronously analyses and rebuilds binary or Base64 encoded files to determine if they contain threats, by comparing them to their known manufacturer's specification. Once the process is complete, the rebuilt file along with either a XML or JSON report, is produced and available as a zip download in the responses section.
NITF (National Imagery Transmission Format) and NSIF (NATO Secondary Imagery Format) files use this same endpoint with no request changes. Analysis reports for these files are available in JSON format only: an XML report request is rejected at submission with a 400 Bad Request (error code 4033) rather than returning a transaction id, so set format=JSON when submitting them. See Gain insights through analysis reports for the full error response.
For more information please refer to our API Documentation.