Introduction
This feature allows you to generate a technical API key to manage your firm through our administration APIs.
Our APIs are designed to enable you to automate the management of your users and client files, saving you time and providing greater flexibility in the administration of your business.
To start using our APIs, simply generate your credentials. You can then authenticate via the OAuth2 protocol, ensuring optimal security when using our APIs.
Why Generate an API Key?
Generating an API key offers numerous benefits for managing your firm:
Task Automation: Automate repetitive and time-consuming administrative tasks, such as creating and managing users, updating client information, managing access, etc. This allows you to save valuable time and reduce human error.
Integration with Your Tools: Connect our APIs with your own tools and systems (CRM, management software, etc.) to create customized workflows and optimize your organization. This allows you to centralize your data and processes for greater efficiency.
Flexibility and Control: Develop your own applications or scripts to interact with our services in a personalized way. You have complete control over how you use our APIs to meet your specific needs.
Improved Productivity: By automating tasks and integrating your tools, you improve your team's productivity and can focus on higher value-added activities, such as advising and supporting your clients.
Generate an API Key
Accessing API Key Generation
⚠️ To access this interface, you must be a Firm Administrator
Go to Admin service
In "Manage accounting firm" of the side menu, click on Settings
Click on API Authentication
Generating the Key
Generating an API key allows you to obtain the credentials necessary to use our administration APIs.
To generate an API key, as part of its initialization:
In the Authentication API section, click on the "Generate Credentials" button.
The system will generate the following information:
Client ID: Unique identifier of your application.
Client Secret: Password of your application, to be kept in a safe place.
Access Token: Initial token to access the APIs.
Refresh Token: Token used to obtain new access tokens.
Sharing Access Token: This Information (Client ID, Client Secret, Access Token and Refresh Token) will allow you to get the necessary access to use the administration APIs.
Refreshing the Key
Refreshing the API key allows you to obtain new access tokens independently, without having to regenerate a complete new API key.
To refresh an API key:
In the Authentication API section, click on the "Refresh" button.
A window will display to retrieve the new token for sharing.
Deleting the Key
Deleting an API key invalidates all associated credentials (Client ID, Client Secret, Access Token, and Refresh Token). This action should be performed with caution.
To delete an API key:
In the Authentication API section, click on the "Delete" button.
A window will appear to confirm the deletion.
⚠️ After deleting an API key, all applications or integrations that used it will no longer be able to access our administration APIs until you generate a new key and update your credentials.