Skip to content

Integrate Mobile Key in your own mobile application

You want to integrate the Xesar mobile key into your own mobile application?

Here is a checklist of things that need to be done:

SectionDescription
Setup and understand XesarExplains why Xesar is needed and what it does.

The Xesar Software is required to provision the access control components and to periodically obtain the mobile key data that is required for access when using the mobile application SDK.

Essentially, it is the source for the input required for a disengage:

Parameter in Mobile SDKParameter in Xesar mobile key dataDescription
mobileIdxsMobileIdsha256-hashed hex-encoded version of xsMobileId found in the Xesar provided data
mobileDeviceKeyxsMOBDKmobile device key string from xsMOBDK found in the Xesar provided data
mobileGroupIdxsMOBGIDmobile group id string from xsMOBGID found in the Xesar provided data
mediumAccessDatamediumDataFrameaccess data string from mediumDataFrame found in the Xesar Provided data

Periodical updates are required, because the mobile key data is subject to validity and confguration changes in Xesar.

How to setup Xesar and provision Access Components?

Section titled “How to setup Xesar and provision Access Components?”

You can find a lot of resources in different languages on how to setup and operate Xesar itself. A trusted EVVA partner will help you get started, especially with the all the hardware - access components

Xesar provides a third party interface via MQTT, that can be used to integrate and orchestrate Xesar from your own services. Here is where you can find the Third Party Interface API documentation for the current and previous versions.

We strongly recommend:

  1. to have your mobile application talking to your service(s) as a middleware towards Xesar
  2. to think about/implement and authentication for your mobile application against your service
  3. to pactice Privacy and Security by Design principles when implementing your middleware

When you want to provide mobile keys to your own mobile application, you need to put Xesar into Mobile self service mode. Note that this change cannot be reverted, so a backup from before this step might come handy if you plan to do so, specially if you already added components.

You can actually obtain the certificates from the REST interface: Access through the Rest API