Scan File For Virus using Net Core
SharpAPIs provide you with a convenient API to scan you files of any size for viruses and any possible malware. In this topic we are going to show you how to Scan File For Virus using Net Core. We are going to use the following file as our input file:
https://virusbotaccount.blob.core.windows.net/automatedtestfiles/demo.docx
First we start a conversion job by making a POST request to the following URL and include these conversion parameters into your request: inputFile and async.
Request parameter descriptions (for the full and detailed description, please click here):
| X-ApplicationID | Your application ID (which you get from your Doc Conversion API Account) |
| X-SecretKey | Your secret key (which you get from your Doc Conversion API Account) |
| inputFile | The file you would like to scan or a URL |
| async | Defines if the request should be sync or async |
Scanning URL
https://api.virusscannerapi.com/virusscan
URL Virus Scanning Example
class Program
{
static void Main(string[] args)
{
using (HttpClient client = new HttpClient())
{
// Adding authentication headers
client.DefaultRequestHeaders.Add("X-ApplicationID", "Get your key from https://app.docconversionapi.com/#/applications");
client.DefaultRequestHeaders.Add("X-SecretKey", "Get your key from https://app.docconversionapi.com/#/applications");
var inputFileUrl = "https://www.docconversionapi.com/samples/example.docx";
using (var requestContent = new MultipartFormDataContent(
"Upload----" + DateTime.Now.ToString(CultureInfo.InvariantCulture)
))
{
// Setting body parameters
requestContent.Add(new StringContent(inputFileUrl), "inputFile");
requestContent.Add(new StringContent("false"), "async");
// Sending a POST request to DCA API
using (var requestResultTask = client.PostAsync(
"https://api.virusscannerapi.com/virusscan", requestContent
))
{
var requestResult = requestResultTask.Result;
if (requestResult.IsSuccessStatusCode)
{
Console.WriteLine([email protected]"This is a response JSON object where you can find fileDownloadUrl: {requestResult.Content.ReadAsStringAsync().Result}");
}
else
{
Console.WriteLine($"Error has occured! {requestResult.Content.ReadAsStringAsync().Result}");
Console.ReadKey();
}
}
}
}
}
}
Local File Virus Scanning Example
class Program
{
static void Main(string[] args)
{
using (HttpClient client = new HttpClient())
{
// Adding authentication headers
client.DefaultRequestHeaders.Add("X-ApplicationID", "Get your key from https://app.docconversionapi.com/#/applications");
client.DefaultRequestHeaders.Add("X-SecretKey", "Get your key from https://app.docconversionapi.com/#/applications");
var inputFileUrl = "https://www.docconversionapi.com/samples/example.docx";
using (var requestContent = new MultipartFormDataContent(
"Upload----" + DateTime.Now.ToString(CultureInfo.InvariantCulture)
))
{
// Setting body parameters
requestContent.Add(new StringContent(inputFileUrl), "inputFile");
requestContent.Add(new StringContent("false"), "async");
// Sending a POST request to DCA API
using (var requestResultTask = client.PostAsync(
"https://api.virusscannerapi.com/virusscan", requestContent
))
{
var requestResult = requestResultTask.Result;
if (requestResult.IsSuccessStatusCode)
{
Console.WriteLine([email protected]"This is a response JSON object where you can find fileDownloadUrl: {requestResult.Content.ReadAsStringAsync().Result}");
}
else
{
Console.WriteLine($"Error has occured! {requestResult.Content.ReadAsStringAsync().Result}");
Console.ReadKey();
}
}
}
}
}
}
After the scanning job has finished processing your file, you will get a response like the following:
{
"id": 0,
"userId": null,
"fileName": "https://virusbotaccount.blob.core.windows.net/automatedtestfiles/demo.docx",
"startedAt": "2020-03-25T12:16:55.0340019+00:00",
"finishedAt": "2020-03-25T12:16:55.2484882+00:00",
"status": "File is clean",
"userIpAddress": "172.96.111.111"
}
If you have decided to make an async request instead of sync then your response will have the same structure but will not contain information like finishedAt etc.
To get your scanning result you will need to send a GET request to the following URL and use the previously returned ID of your scanning job.
https://api.virusscannerapi.com/virusscan/{{id}}
If you have any questions or need any further help, please contact us at [email protected].
