Fingerprint ekey bionyx integration

Hi Guys,

I have a fingerprint sensor installed for the front door of my house. Manufacturer is ekey, and the controll unit of the system is connected to LAN/WLAN.

I searched for an integration into HA, but didn’t find anything about it (which confuses my a little bit, I thought ekey is one of the most used fingerprint systems).

So I checked the website of the company and reached a own subsite for developers to connect the ekey system (https://developer.ekey.net/). As far as I understood there are APIs as well as communication can go through HTTPS requests. At this point I was not able to understand more, as I have no development skills.

Any chance that anybody else with more development skliss is interested in ekey integration?

Even any other hint how to integrate the system would be appreciated!

MaTekki

Hi, from what I have read in their developer wiki, their service can authenticate you through the fingerprint scanner and then trigger some third party service through the HTTPS requests. There is no way that the third party service would lock/unlock the door. The requests go from eKey to third party API. eKey itself does not provide any own API.

Thank you very much docek! That is even more information than I could understand out of the developer guide.

I don’t see a usecase for me that a fingerprint should trigger something in HA. I will investigate further on the KNX integration they provide to see if this is an suitable way for me.

What’s your idea about the integration? I will be in the same position in about 4 months when I will move to my new home where I have a Ekey xline device.

The current Ekey http request can provide you information about a door which has been opened which could be used in a home automation for a somehow but I also do not see the point because there is nothing which couldn’t be also achieved by using a simple motion sensor…
On the Ekey roadmap there is plan to also provide the finger/user information in a later release which will increase the options for home automations.

When you are looking for a possibility to remotely open your door, then you need to focus on the relay which is connected to the motorized door look. It will give you the possibility to connect a Shelly 1 or Shelly uni and use it as switch to open the door. That’s at least what I will try to achieve.

Has anyone figured out how to receive the HTTPS Requests in Home Assistant?
I would like to get the events from the fingerprint sensor at the front door to for example turn on the lights, when entering the house.

which version do you use for ekey? i have Ekey net and have mode a integration with Home Assistant and Node Red. Node red catch the http request and from there i can use it to do some actions.

https://flows.nodered.org/flow/f5413a8e663aaac43e587cebc5423c62

I am in the process of ordering an have read on the weekend, that there are some upsides to the current version (d-line) which came out 2021, but it has still not reached feature parity with the previous version, being ekey net.
Especially if you would like to know which finger/person was scanned or if access has been declined. Ekey is promising to add these features, but unfortunately there is no timeline. I will ask for an offer of the old system and then decide which route I will go for.

It’s good that it works within Node Red to receive and interpret the HTTPS Requests send by ekey, however I am not using node red so far and would prefer a native integration. Home Assistant does provide a Restful integration. Maybe this can be used to build the integration around without much effort. I myself are too inexperienced with Python.

Edit: The d-line currently does not provide any content, it simply triggers a http request, that can be manually defined within the ekey app. If I am not mistaken and have understood the home assistant and ekey documentation correctly, I could use a webhook trigger, and use the home assistant created ID in the ekey app to define the http request address. Within home assistant the webhook can then trigger an action. Is this correct?

i think that will work, my ekey net only sends udp requests. thats the reason i use node-red.

i use the https request at the bionic app and this is my trigger in a automation.

  1. you open a new automation
  2. trigger is Webhook
  3. you copy the webhook id
    4 you go in the bionyx app to "http(s) request.
    5 you fill the url: http://IP-adress from HA:port/api/webhook/"webhook ID from HA
    6 you go to function and put the http request to the finger

thats all i hope that help.

1 Like

Thanks for this easy way to integrate. Works fine!

Ekey now has a new Notification API.
This API gives you more possibilities then the normal HTTP(S) requests, as it gets triggered even by failed attempts and adds details about the event in a JSON. That way you should be able to use a single webhook for all users and even for failed attempts.

1 Like

Glad to find this thread, and recent updates as considering ekey fingerprint for door access and could ideally integrate that with homeassistant.

Which versions are you all using, the d-line?

Has anyone looked at the APPMODULE solution? It looks more like a closed ecosystem requiring purchasing of integrations.

I have the Ekey xLine.
The Appmodule costs way too much for me.
If you have a KNX system, you might also take a look at the OpenKNX fingerprint which has direkt KNX integration and costs way less then ekey.
I already had an ekey when it first came out but otherwise I would probably have used it instead.

Have you been able to push notiications to home assistant?
I failed so far setting up a working webhook for the api notification.

I just discovered this API a few days ago and didn’t have the time to test it yet

Would be great if you could let me know if you were successfully. I tried to contact ekey developers but haven’t received a feedback yet.

Ekey recently rolled out the notification API - at least they intended to and rolled it out for my System. I am now able to post the desired information to a webhook. The Thing is, while it works with the testing site provided in the documentation (link: Documentation Notification API - Notification API - ekey developer), i can"t get it up and running in Homeassistant.
Ekey adds URL/api/notification/finger or URL/api/notification/input to the given URL.

I use cloudflared in combination with let"s encrypt to expose my Homeassistant instance and get a valid SSL Cerificate for it locally. Then i override the public Adress host.mydomain.link to the specific ip on my local DNS.

With my Mobotics Doorbell, it works fine, but Ekey runs into errors, permanently.
Unfortunately, you only see that you ran into an error, but you can’t see what error you ran into. I tried the webhook address “as is”, added Ekeys modifications to it, changed the SSL Validation types, but no success…

Any idea, how this can be fixed?

Best regards.
Marc

Edit:
I Tried the webhook with the standard 3rd Party api provided by the bionyx app and it works, the same webhook with the same settings doesn’t work in Notification API…

Where do you see the errors?

The Fingerprint reader falsches Red after performing the entry Task… Unfortunately there ist No other way to Tell what Kind of Error occured… The App doesn’t offer a possibility to Test the webhook in the App.
At least Not yet, i proposed the Testing possibility to the development Team from ekey.

any news about that? I have the eKey http request working but want to use the new Notification API / webhook.
Thanks