Authentication

Get your API keys

To start using the API you will need an API Key. Keys can be generated via VScanner's dashboard. Once you have generated a new API Key be sure to keep it safe. Don't worry you can always delete the created key and create a new one via the dashboard.

To send authenticated requests you will need to pass the API key via the "Authorization" header. Below is a cURL example of sending a request passing the key:

curl https://api.vscanner.ai/v1/api/list_scans \
  -H "Authorization: Bearer {API_KEY}"

Python example:

import requests
​
# Your API Key
api_key = 'YOUR_API_KEY'
​
# Base URL for the API
url = 'https://api.vscanner.ai/v1/api/list_scans'
​
# Headers with the API Key for authentication
headers = {
    'Authorization': f'Bearer {api_key}',
}
​
# Making the GET request to list scans
response = requests.get(url, headers=headers)

Currently only the API plan or Custom plans are capable of generating API keys.