The Parakey service is built up of many resources. Below is a short description of some of the resources for a better understanding of how to use the API.
- Domain (Place)
Every account is divided into a Domain, grouped by a specific area (for example an office, a parking garage or a building) that belongs to a Customer. Domains are also used to group different users so that two companies can share the same doors but use different Domains to administrate their users.
A User is a personal account identified by its email address. A user needs to be invited and can not sign up by themselves. When a User is added, or an AccessKey is given to a user they will automatically be created if they do not exist. They will receive an invitation email with a one time password and instructions on how to get started.
A User can have different roles (as a regular Guest or different administrative privileges) and can be linked to one or several Domains, and be assigned different AccessKeys that they use in their Parakey app to unlock doors.
- Access (Key)
An Access (equivalent to Key in the web portal), is the resource that controls access to one or several doors. An Access can be configured with time and security restrictions.
- EventConfiguration (Door)
An EventConfigruation represents the physical door. These are usually added by an installer, you create a Key that contains one or multiple doors.
The AccessKey is the link between a User and an Access. If the linked access doesn't have any time restrictions, you can set a custom start and expiration date on the AccessKey.
When a User opens a door using the Parakey app, an Eventlog is generated and stored. The EventLog contains a timestamp and information about the User and all resources related to the event. EventLogs are cleared of personal information after at most 30 days (can be configured per Domain).