To ensure the security of your data, the Commusoft v2 API requires an active API Key for every request. All communication must be conducted over HTTPS.
Your API Key acts as a powerful credential that provides access to your Commusoft account data.Private Apps: Keys can be generated directly within the Commusoft /Settings/Private applications by an administrator.Partners: Will use oAuth as part of your authentication flow. This allows the partner to connect to one or many Commusoft clients. This will be discussed with you once you've completed onboarding on the partner program. To register, go to www.commusoft.com/partnersSecurity: Treat your API Key like a password. Never share it in public repositories, client-side code (like frontend JavaScript), or insecure communication channels.
We provide two distinct environments to ensure you can develop and test your integration safely:Production UK production: https://app.commusoft.co.uk/api/v2 US/Canada production: https://app.commusoft.us/api/v2Please use the appropriate URL based on the location of the business.Sandbox Available on request and may come with additional charges.Important: API Keys are environment-specific. A key generated for the Sandbox environment will not work on the Production environment, and vice versa.
