To ensure the highest levels of security and integrity, the Synapcus Automation API employs a contextual API key mechanism. This approach is central to safeguarding access and operations, enabling secure automation scenarios within the Synapcus ecosystem. Developers and cloud service providers can obtain their unique Automation API key directly from the Synapcus user interface. This key is accessible by navigating to
"User / Profile Settings / General"
within the Synapcus platform.
Upon obtaining the API key, it is imperative to store it securely. The key serves as a critical credential, granting the bearer the ability to interact with the Synapcus data and functionalities. Therefore, it should be handled with the utmost care, akin to sensitive personal or business information.
The Synapcus platform provides an option to refresh the API key at any time via a dedicated "Refresh" button found in the same UI section. This feature is crucial for maintaining security, especially in scenarios where the key might have been compromised or when policy dictates regular rotation of credentials. However, it is important to be aware that refreshing the API key will invalidate the previous key. Consequently, all external applications, scripts, or services utilizing the old API key for authentication will need to be updated with the new key to restore their access and functionality.
To minimize potential disruptions, plan the API key refresh carefully. Ensure that all stakeholders and systems relying on the Synapcus Automation API are promptly updated with the new key. Implementing automated or semi-automated processes for distributing and updating the API key across dependent services can significantly streamline this maintenance task, enhancing overall operational efficiency and security compliance.