Overview
Introduction
The term 'BlueID SDK for Mobile' should be used here as a comprehensive term for the BlueID SDK for Android and the BlueID SDK for iOS. This section of the documentation tells you where to get it and how to implement it in your app. We deliberately avoid code examples as program languages evolve, and we kindly refer you to the sample applications that come with our SDKs.
Prerequisites and getting the SDKs
You can get the current version of our SDKs from the BlueID GITLAB. The BlueID SDK for Android requires Android 5.0 or later whereas the BlueID SDK for iOS requires iOS 10 or later.
The SDKs are bundled in ZIP files and can be verified against the signature we supply to ensure their integrity.
On security
Our SDK uses the keychain (on iOS) and the hardware-backed keystore (on Android) to store sensitive data locally on the smartphone. The communication with our backend services is secured using TLS.
Third party components and their licenses
Please refer to our BlueID Open Source Software Documentation for more information.
Glossary and basic terms
Here, we only list the terms that are required to understand this documentation and to develop a mobile app for BlueID ACCESS:
| Term | Description |
|---|---|
| ACaaS | Acess as a Service: BlueID's access solution for facilities |
| Channel | a physical communication channel or technology like NFC or Bluetooth Smart |
| Command | an instruction sent to a lock, e.g. to open it temporarily |
| Command execution | the process of sending a command to a lock |
| IDaaS | IDentity as a Service: Foundation of ACaaS and BlueID's identity and authorization service based on pseudonyms |
| Initialization | the process of creating a new cryptographic identity on a mobile device and registering it at the BlueID backend |
| Invitation Code | a code that was sent by the Access backend to the user to allow the initialization of a mobile device |
| Key | a permission granted to a user for accessing a lock |
| Lock | a physical lock |
| Mobile | a smartphone, in terms of the BlueID SDK for iOS and Android |
| onTouch | a BlueID technology to access locks without having to open an application and triggering a command execution manually |
| Operator | a dedicated customer account in the IDaaS system that has certain mobile devices and locks that are matched to an account |
| Resident | the BlueID Access term for an end user |
| Synchronization | the process of fetching keys for a mobile from the backend |
| Tenant | the person or company which provides BlueID services to your customer |
| Token | like a Key, but used only in IDaaS |