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. Enable Swagger
  2. Download and install Python 3.7 or newer, 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
  3. Open a Command Prompt as Administrator
  4. Run the below command:
    pip install requests
  5. Open FTK, Lab, or Enterprise and go to Tools > Access API Key
  6. 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.
    https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/69009876010/original/mceclip0.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAS6FNSMY2XLZULJPI%2F20210926%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210926T164420Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=97ac570f6c8ecd828181ec639a7e1785dd5023628e81cde184188a0d5bd67ca4
  7. 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 appropriate attached BAT test Python script to coincide with your installed API version, 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, as shown in the path below:
    //Server/share/Cases
  5. Save your changes
  6. Double-click the script to execute it
  7. At the end of the script, it should report "Created case" followed by the case id
    Note: If not case id is shown, then the case was not created successfully, and you should review "%PUBLIC%\Documents\AccessData\AccessDataLogs\adgselfhost.txt" for any errors.

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.