With numerous integrations and systems relying on API keys for data exchange, having the right level of control over each access point is essential. NotifyVisitors understands this need, offering robust options to manage multiple API keys within your account. With the option to create, edit, and disable multiple API keys, NotifyVisitors empowers businesses to strengthen security, streamline data access, and control access permissions across multiple applications.
This article explores the benefits and steps involved in managing API keys in NotifyVisitors, covering everything from creating new keys to setting scopes, editing, and deleting them. Let’s dive into how you can optimize your platform’s security and flexibility with this valuable feature.
Why use multiple authentication keys?
When using a single API key, all integrations (such as web SDK, Android SDK, and reporting APIs) share the same access credentials. While this default approach can work for many setups, businesses often have distinct applications or third-party vendors accessing data, each requiring unique credentials for added security.
Multiple authentication keys offer key benefits:
- Enhanced security: Different keys can be used for each integration, limiting exposure if one key is compromised.
- Easier management: Keys can be individually disabled or refreshed without affecting other integrations.
- Controlled access: By assigning scopes, you can limit each key’s access to specific integrations, ensuring data is shared only where needed.
How to manage API keys in NotifyVisitors
To begin managing API keys, you need to access the NotifyVisitors dashboard and navigate to the 'Settings' section. Within 'Settings', locate and click on 'Store Integration' section, which is the primary area where API keys are managed.
1. Accessing your default API key
When you create a new account in NotifyVisitors, default API Key and Secret Key are automatically generated. These keys are essential for initial integration and can be found in the dropdown menu within the 'Store Integration' section. You can click to copy these keys for immediate use.
2. Creating additional API keys
To create additional authentication keys, find a 'Create New Key' button under the store integration section. Clicking this button initiates the key creation process. A pop-up window then appears, prompting you to select the desired scope for the new API key.
First provide a name for the new key for easy identification and then choose from the available options including Web SDK, App SDK, Integration REST API, and Reporting API.
- Web SDK: Integrate NotifyVisitors’ features into your website for real-time visitor tracking, notifications, and data collection.
- App SDK: Embed NotifyVisitors within mobile apps to track user behavior, send push notifications, and collect in-app data.
- Integration REST API: Connect NotifyVisitors with external systems, enabling data synchronization and automation via API calls.
- Reporting API: Access detailed analytics and performance metrics programmatically for custom reporting and trend analysis.
The newly created API key will appear alongside the default one and any other keys you’ve created, ready for integration.
3. Editing, deactivating, or deleting API keys
To further manage your API keys, you can use additional options available next to each API key:
- Enable or disable: Every key, including the default, has an enable/disable toggle. This allows you to deactivate keys that are no longer in use without deleting them, which may be helpful if you plan to re-enable them later.
- Edit scope: To adjust the scope of an API key, click on the three-dot menu next to the key and select Edit. This will allow you to update the scope and rename the key as needed.
- Delete key: If a key is no longer required, click the three-dot menu and select Delete.
Key limitations
- The default key can only be turned on or off; you can't rename it or change its scope. Additionally, the default key cannot be deleted either.
- NotifyVisitors sets a limit on the number of API keys you can create, allowing up to five new keys beyond the default key. If you reach the limit, an error message will prompt you to delete an existing key before adding a new one.
Conclusion
Mastering API key management in NotifyVisitors can transform how you handle data security, access control, and integrations. With options for creating, editing, and disabling multiple API keys, NotifyVisitors provides flexibility while prioritizing the safety of your data.
Embrace these API key management features and take full advantage of NotifyVisitors’ capabilities to optimize your platform’s security and operational flexibility.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article