We always recommend creating separate keys for integrations (both partner integrations and custom integrations). This is to avoid mixing up users managed via integration and those invited manually via the web portal.
❗️ Only allow usage via API for the keys that are to be used by the integration. By default, an integration has no access to any keys at all.
Allow API integration for a key
Create a new key or press on an existing key that should be managed by an integration.
Under Settings, by Permissions, press Edit.
Activate Allow to be used with API.
Press Save.
The API section is displayed in the detail view of the key, with more information.
👉 In some cases, the system you want to connect to Parakey may ask you to enter an Alias ID (e.g. a room ID, or an object ID they provide), then enter it in the Alias ID field.
❗️Remember that you must select this key or enter its Access ID in the system you want to connect to Parakey.
Show which keys allow API integration in the key table
You can choose to display the API Integration column in the key overview to easily see which of your keys allow usage via API.
Press the icon to the right of the column headings.
Check API Integration.
The overview updates automatically.
