5.15.2 api mobilekey compatibility

The api/mobilekey/compatibility function is used for reading and writing of location IDs and encryption keys for Bluetooth Authentication (WaveKey).

Service and Privileges Groups

  • Service group is API Access Control.

  • Privileges group is Access Control (Control).

Methods

  • GET – returns the WaveKey compatibility mode activation state

  • PUT – sets the WaveKey compatibility mode activation

GET request

There are no parameters used for GET request.

GET /api/mobilekey/compatibility
Example of Response to GET Request:
{ "success": true, "result": { "compatibilityMode": false } }

PUT request

The PUT request contains parameters in the application/json format.

Table1. PUT Request JSON Keys

Key Name

Mandatory

Expected Values

Description

compatibilityModeYes
true / false

Compatibility Mode ensures the WaveKey function for those users who cannot update to My2N 3.5.0 (Android) or 3.7.0 (iOS) and higher. Once the Compatibility mode is deactivated, the primary key has to be generated again.

Example of PUT Request:

PUT /api/mobilekey/compatibility
Content-Type: application/json

{
  "compatibilityMode": false
}

Example of Response to PUT Request:

{
  "success" : true
}