FloQast has a new Open API currently in Alpha Testing. If you would like to have this feature enabled and participate in this Alpha Test, please reach out to your team's Accounting Success Manager or Support@floqast.com.
Documentation and Instructions for building to the API will be provided as part of the Alpha Testing program.
The first thing you will need to do once FloQast has enabled the Open API for your team is to generate an API key. After the feature has been turned on, Admins and System Admins in your FloQast will be able to access the API Keys settings tab in their Admin Settings. Once there, they will be able to see any previously created API Keys, as well as create a new key.
After clicking that Create New Key button you will be able to configure the new API key's settings by filling in the following fields:
- New API Key Name: In this field, you will put the name for your API Key.
- Expiration: This is the date the API Key will expire. You can choose from 365 days, 90 days, 60 days, 30 days, a custom date of your choosing, or no expiration. FloQast strongly recommends setting an expiration date for security purposes.
- Select API Services: You can choose which API Services you would like this key to have access to. Currently, you will have the option to pull Reconciliation Analytics data, but Checklist Analytics data will be out in the near future.
After filling in those fields, you can click Create API Key, and your new key will be created. This will bring you back to the main settings tab, with your new key available to copy. This is the only time this will be displayed. After leaving this page, you will not be able to access this key again.
After your key has been created, you will be able to see the Key Name, the services the key has access to, the Admin who created the key, the date the key was created, the date the key was last used, the key's expiration date and status, and you can delete the key by clicking the trash can to the right.
After a key is deleted or expired, you will be able to see the deactivated and expired keys as well, alongside the date the key was deactivated. You can also filter the list of keys by Active, Expired, and Deactivated.
If you have any questions about generating an Open API key, please reach out to your Accounting Success Manager or email@example.com