Follow

API Basic Acceptance Test (BAT)

Created by: Brendan Bone
Created date:
Last Updated date:

Prerequisites

  • 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

 

Preparation

  1. Download and install Python 3.7, following the notes below:
    1. Perform an Customized install
    2. Check the option to install PIP
    3. Check the option to install for all users
    4. Check the option to add it to the environment variables
  2. Open a Command Prompt as Administrator
  3. Run the below command:
    pip install requests
  4. Open FTK, Lab, or Enterprise and go to Tools > Access API Key
  5. 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.
    mceclip0.png
  6. 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)

 

Procedure

  1. Download the attached BAT test.py and open it in a text editor
  2. Update the quincURL variable to be your Quin-C base URL
  3. Update the apiKey variable to be the API key generated in previous steps
  4. 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.
  5. Save your changes
  6. 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.

 

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk