Alias Id can be used to create a stateless integration with Parakey. Using an alias Id there is no need to store any extra information about Access id in the integrating system. Instead, Parakey will handle the mapping between your Id and the Parakey Access Id.

Please note that alias id is optional and you should only use an alias Id or the Access Id.

Create or update Alias Id on Keys (Access)

To use alias Id in your API calls, you need to enter the Alias Id in the Parakey web portal. This should represent a unique identifier in your system, for example, a room id.

  1. When creating a new key or find the key you want to update and press "Change settings".

  2. From the settings screen make sure "Allow API integration" is active

  3. Press "+ Show optional settings" to view all Key settings.

  4. Enter an alias Id
    We always recommend using a prefix for you alias id, since the id has to be unique within the Parakey system. For example prefix with your company name.

To use the alias id, simply use this instead of the Access Id.

{
"insert": [{
"access": { "aliasId": "Parakey-123ABC" },
"user": { "email": "[email protected]" }
}
}

Did this answer your question?