FlexyKey API

Welcome to the information page of the FlexyKey REST API.
This API provides powerful control of FlexyKey or Evva system from any third-party application.
The functionality that can be provided differs depending on if its a FlexyKey or Evva unit, each function contains information about this.
Not all functions are supported, some functions has to be managed through respective web administration.

Features

Currently, these features can be controlled via API:

• Control unit outputs and get IO status (F1, F2 and X1–X64) for your FlexyKey units.
• Manage bookings for objects containing FlexyKey and/or Evva units.
• Manage Units. Get information about your FlexyKey or Evva units.
• Access unit logs for Flexykey (not Evva)

Some functions cannot be controlled through the API,
they have to be administred through either FlexyWeb admin pages or Evva Airkey Online administration. This concerns mostly parts which are set up only once:

• Registering new units or locks and their assignment to bookingObjects
• Adding new RFID access media like cards and key tags
• Administrative settings as buying credits or requesting API keys

API activation

You need to have a existing username and password within FlexyWeb to access the API,
The user also must have API privilegies, contact FlexAccess AB for more info. Username and password is sent through a HTTP header (Basic Authorization) every time you access the API. The swagger documentation provides a test environment for development purposes, with a demo user account.
Another convenient option is to use a tool like Postman.

API usage

Data format JSON

JSON notation is used throughout the API:
Responses are returned as JSON
PUT and POST request bodies expect JSON
Encoding utf8

Date and time format

Timestamps are generally provided in ISO 8601 in UTC date and time format, with 'Z' included.
Format: yyyy-MM-ddTHH:mm:ssZ

 Example: 2020-10-21T10:21:11Z    

Dates in responses are also generally returned as ISO 8601 in UTC.

URL encoding

Make sure to properly apply URL encoding for query parameters according to RFC 3986.
HTML URL Encoding Reference

Paging

Currently, paging is not supported. Control and limit your results via date intervals or query parameters.
Up to 500 entries can be returned in one request.

Details: Booking

The field bookingId is a unique identifier for the booking and is automatically created and returned in the response after successfully adding a new booking.
To be able to make a booking you have to know the bookingObjectId that is targeted.
The field bookingObjectId is a unique identifier for one or more units with combinations of units/locks and/or relays.
Currently, creating of such bookingObjects has to be done in FlexyWeb, they are read-only in the API.
It is possible to set your own identification or search criteria with the optional field secondaryIdentification (string, max. 20 chars.)
Settings for SMS and email notifications for bookings are also set in FlexyWeb.
All phonenumbers in a booking must start with international prefix (must start with '+' character) e.g. for Swedish phonenumbers +46XXXXXX.
Keypad code:s can be 4 to 7 digits long, rfid:s consists of 10 numerical characters as read from FlexyKey.
Currently, only phonenumbers are valid when booking with Evva locks/readers.
If any of the phonenumber, keypadcode or rfid positions are not used, it must be marked as an empty string "".

The startDate and endDate shall be formatted as described above with appropriate timezone.
Evva locks are automatically set to the correct local timezone and need times relative to their time zone. FlexyKey units have to be configured for correct local timezone.

Currently there is no way to change a booking, it has to be deleted and a new booking created instead.

Swagger documentation »

FlexAccess AB Home page »