Introduction
What is Parakey?
Parakey is a digital key platform that allows you to unlock doors with your mobile phone instead of physical keys, cards, or tags.
Integration Options
API – Connect Parakey to your existing systems (HR, booking, or membership systems).
SDK for iOS & Android – Integrate Parakey and unlock directly within your own mobile app.
Parakey App – A ready-to-use app for those who want to get started without custom development.
Who is this guide for?
This guide is designed for both technical and non-technical audiences.
Decision-makers and managers can get an overview of how Parakey works.
Developers will find links to the more technical documentation (API and SDK).
Use Cases
Parakey is used in many industries and scenarios:
Companies – Automatically grant employees access to offices through your own systems.
Property owners – Connect Parakey to booking systems (e.g., laundry rooms, storage, garages).
Coworking & membership – Assign digital keys directly upon registration.
Parking – Provide access to locked garages when a customer rents a parking space.
💡 The result: The right person gets the right access at the right time — fully automated.
Getting Started
Checklist
Before you start integrating:
Create a Parakey account (required for API and SDK).
Retrieve API keys from Parakey Admin (all integrations use the API).
Choose your integration method:
API only – If you want to connect Parakey to your systems while users continue using the Parakey app.
API + SDK – If you want to integrate Parakey directly into your own app (the SDKs use the API behind the scenes).
Test in the sandbox – Start in the test environment before going live.
👉 Detailed guides: Help Center – Integration via API
API Integration
What is the API?
The Parakey API allows you to connect your systems with Parakey. Common use cases include:
Creating/updating users
Granting or revoking keys
Fetching logs and events for analysis
👉 Full technical documentation: Parakey API
👉 Guides and examples: Help Center – Integration via API
SDK Integration
What are the SDKs?
The SDKs let you integrate Parakey directly into your own mobile apps. The end user can then unlock doors without needing to download a separate app.
When should you use the SDK?
You already have your own app (e.g., employee, member, or tenant app).
You want to offer a seamless experience within your existing app.
You want full control over the design and user journey.
👉 For developers:
Architecture & Flows
Core Concepts
To understand how the integration works, it’s useful to know the key building blocks in Parakey:
Place – A building or facility that contains Locks, Users, and Keys.
Lock – The physical door lock controlled digitally.
User – A person who can access one or more Place and Locks via one or more Keys.
Key – Links a User to one or more Locks and Place, defining what access they have.
💡 A key isn’t a physical object — it’s a digital assignment that defines a user’s access.
How It Works in Practice
Your systems communicate with Parakey Cloud via the API.
Parakey Cloud manages users, keys, and logs.
Mobile apps store the keys and are used to unlock doors.
Locks are opened locally via Bluetooth.
Important Principles
Security: All access is centrally managed and logged in Parakey Cloud.
Flexibility: Works with both the Parakey app and your own app via SDK.
Scalability: Supports many doors, users, and integrations simultaneously.
👉 For technical details on authentication, error handling, and code examples, see the API documentation and SDK-documentations.
Support & FAQ
Common Questions
What happens if the phone is offline?
Keys can be stored in the app and used offline, within defined rules.
How long is a digital key valid?
That depends entirely on your Parakey settings (temporary or permanent).
Help & Resources
Guides: Help Center – Integration via API
References: Parakey API
Support: Contact Parakey for direct assistance.