The Parakey API is a great tool to integrate Parakey into your own service and distribute mobile keys. There are two different ways to create an integration with Parakey:
Place API (Single place integration): Create an integration for a single Place in Parakey. Typically developed in-house or by a contractor that develops the integration for you.
👉How to use Place API (single place integration)
Create an App (multi-place integration): Create an "Application" that can be added to multiple places. You can monitor and manage the app from our development hub. This is the preferred way if you are a third party company that wants to create an integration to Parakey to handle user and access.
👉How to create an app (multi-place integration)
How do we get developer access to try the Parakey API?
To become a developer you need to have a Parakey account. Please contact [email protected] to get an account.
Sign in to your new account in Parakey Web Portal.
Follow the steps for Place API (Single place integration) to try the API.
Once the integration is ready, follow the steps under Moving to production.
All requests shall be done over HTTPS to https://api.parakey.co, the relative path prefix /v1.x indicates the version of the API. We will only change the version prefix on major API changes with possible breaking changes.
New in API 1.2
Starting with API version 1.2 we have created a new endpoint to manage AccessKeys. This endpoint is created to make it as simple as possible to add/update or remove access from users without the need to keep a state in your application.
👉Read more about how this endpoint work in the Manage Access article.
API enabled keys
Every key used in the integration needs to have API permissions enabled. We recommend creating specific keys that are only used together with the API.
How to see which keys are allowed to be used with API
❗️ This instruction refers to the Beta version of Parakey Next Gen Portal which can be accessed by clicking on Try Parakey Beta at the top right of the portal. We recommend that you view keys there.
Go to Keys and press the columns settings icon.
Check API Integration. The table will automatically be updated with this column. It says Yes in this column if a key is allowed to be used with API.
💡 To allow a key to be used with API, toggle Allow to be used with API under Permissions in the key settings when creating or editing a key.
How do I find the ID for X?
As an API administrator, you can always find the ID for your resources in Parakey Web Portal. Simply sign in to your account and follow these steps:
domainId: Go to the Developer page by pressing the Development button in the top right corner (only visible if you are an API administrator). Here you will find a list with all the Domains with the corresponding IDs that you have access too.
accessId: Go to Keys, click on the key you are interested in. On the details page that is displayed on the right, scroll all the way down and you will find the Access ID if the key is enabled.
Can I unlock the door with the API?
The API is only an integration with the Parakey mobile key distribution platform, to unlock doors users need to use the Parakey app. The app uses Bluetooth to connect to the Parakey unit to unlock the door.
How to test the integration
Once you are ready to start the integration we will create a demo Domain account for you to use, where you can try all API features and sign in to Parakey Web Portal to verify that keys are being created as they should. If you want an end to end test you need to purchase a Parakey unit or try at your customer's location (if they have Parakey installed).
What can I build using the integration?
Booking system - automatically send mobile keys that lets your members unlock doors during their current booking.
Business system integration - Sync your member or employee directory and automatically distribute mobile keys to your employees.
Calendar integration - Send mobile keys to unlock meeting rooms for a specific time slot.
Guest notification - Send a message to the person who invited someone that notifies them when their guest has arrived and unlocked the door.
👉 Head over to the full Parakey API specification ↗️, where all endpoints and examples are documented.