Hoppa till huvudinnehåll
Alla samlingarFor developers
How to get started with your integration
How to get started with your integration

A guide to get you started with your integration. Read this before you head over to the API specification.

Emil Janitzek avatar
Skrivet av Emil Janitzek
Uppdaterad för mer än en vecka sedan

Make sure to read this article before you start exploring the full Parakey API specification ↗️, where all endpoints and examples are documented.

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:

  1. Create a Custom Integration: Typically developed in-house or by a contractor that develops the integration for you.

  2. Create 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 handle user and access.

How do we get developer access to try the Parakey API?

  1. To become an integration partner you need to have a Parakey account. Please contact [email protected] to get an account.

  2. Sign in to your new account in Parakey Web Portal.

  3. Follow the steps for Custom Integration to try the API.

  4. 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 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

  1. Go to Keys and press the columns settings icon.

  2. 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 integration - 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.

Fick du svar på din fråga?