- A working installation of FTK, Lab, or Enterprise in conjunction with Quin-C Server
- A valid FTK, Lab, or Enterprise license
- A valid "ADAPI" feature license
- Download and install Python 3.7, following the notes below:
- Perform an Customized install
- Check the option to install PIP
- Check the option to install for all users
- Check the option to add it to the environment variables
- Open a Command Prompt as Administrator
- Run the below command:
pip install requests
- Open FTK, Lab, or Enterprise and go to Tools > Access API Key
- Highlight the administrator user for whom you need an API key, and click Generate Key
Note: API keys inherit the permissions of their associated user.
- Take note of the generated API key, as it is only shown once (a new key must be generated if the current key is lost)
- Download the attached BAT test.py and open it in a text editor
- Update the quincURL variable to be your Quin-C base URL
- Update the apiKey variable to be the API key generated in previous steps
- Update the caseFolder to be your default case folder
Note: This must be a UNC share that the Quin-C service account has full access to, and you must replace back slashes in the path with forward slashes.
- Save your changes
- Double-click the script to execute it
The script should prompt for a case name, then attempt to create a case with that name. If case creation is successful, then your API should be working correctly.