The Parakey API is a great tool to integrate Parakey into your own service and distribute mobile keys. You can create:
A Manual Integration: Typically developed in-house or by a contractor that develops the integration for you.
A Partner Integration that can be added to multiple places: You can monitor and manage the integration 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 manage user and access.
How do we get developer access to try the Parakey API?
To become an Integration partner 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 a Manual 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
Manage access endpoint
We recommend managing users and their access using the Manage access endpoint.
👉 Read more about how this endpoint works 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
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.
👉 Head over to the full Parakey API specification ↗️, where all endpoints and examples are documented.