- Register for an API key by creating an App: QuickFile > Account Settings > 3rd Party Integration > API
- Click Create a new App.
- Give your application a name and a description.
- Select which method(s) you want to use (Ctrl+click for multiple selection) and click Add selected.
- Click Save Application.
- Make a note of your "AccNumber" and "ApplicationID".
- Click Click here to return to the App Overview screen.
In order to authenticate, you'll need some details. If you didn't make a note of these details when you created the app, follow:
- Navigate to Account Settings > 3rd Party Integration > API
- At the top, to the right of the "Create a new App" button will be your "Account API KEY".
- Find your application in the list (probably only one) and to the right click the blue question mark.
- Make a note of your AppID. NOTE: THIS IS DIFFERENT TO YOUR ACCOUNT API KEY.
- Get your account number from the top right of the QuickFile browser window (below your company name).
- Copy the contents of
QuickFile_Example.ps1
into a new PowerShell editor session (e.g. ISE or VS Code) or clone the repo to your computer. - Complete your details for
$AccountNumber
,$ApplicationID
and$Api_Key
. For example:$AccountNumber = "123456789" $ApplicationID = "de3aab49-22e4-14e2-3ef2-a4ef88da81d0" $Api_Key = "9A22339C-622F-AF2A-D"
- Modify the
Endpoint
parameter according to the QuickFile API Endpoint documentation. For example:$Endpoint = "https://api.quickfile.co.uk/1_2/system/getaccountdetails"
- Modify the
$Payload
'sBody
data according to the method you are using.
Try running the script.
The API KEY and ApplicationID are fictitious.