Feedback Management
API Keys
Learn how to create and manage API keys for your encatch project
Managing API Keys
API keys are essential for integrating encatch feedback collection into your applications. They provide secure authentication between your application and the encatch platform.
Understanding API Keys
Each API key consists of:
- Name: A descriptive identifier for your reference.
- Key Prefix: Helps you identify the generated key with the key name
- Expiry Date: When the key will automatically expire
- Application Name: The app names for which the key is valid. This is used to link which feedback forms are linked.
- Environment: The environment for which the key is valid. Test keys are used for testing purposes and are not counted towards your usage.
- Allowed Domains: The domains (for website it is the domain name and for mobile app it is the bundle id) for which the key is valid. This is used to restrict the key to only be used on specific domains.
Use * Asterisk to generate a key for all domains. Not recommended for production environments.
Important Notes
- System does not store the generated key. Incase you lose the key, you can generate a new key and use it in your application and delete the old key, keeping the application name same.
- Keep application name same across two keys which are meant for same purpose when old key is about to expire.
- API keys are public when embedded in public websites. We apply rate limits to prevent abuse and ensure that the APIs (called from SDKs for feedback fetching and submission) is used fairly by all users. For information on rate limits, refer to the Rate Limits guide.
Permissions
Permissions are associated with the API key and are used to control the actions that can be performed with the key.
- Users: Manage users who can use the key.
- create: Use create permission if you want to add a new user using the key.
- delete: Use delete permission if you want to remove a user using the key.
- update: Use update permission if you want to update the users using the key.
- read: Use read permission if you want to view the users information using the key.
- Feedback Forms: Manage feedback forms that can be used with the key.
- create: Use create permission if you want to submit feedback using the key.
- read: Use read permission if you want to read feedback configurations using the key.
Important Notes on Permissions
- When creating API keys for frontend SDK's you enable create and update permissions, so that new users created in your application are automatically synced with encatch users in the current project.
- You would chose not to enable the create permission if you have fixed users and prefer to sync from backend directly. Example,employee based applications where users are managed by HRMS.
- When creating API keys for website (no login applications) you disable all user permissions, so that no one can create users, but can only submit feedback anonymously.
How is this guide?