Prerequisites for using the Welcome IP local API

The welcome IP local API is capable accessing the door entry system access points of end users when they are connected to the local network. For this, a few prerequisites have to be met by the end user.

Topology

The 3rd Party Panel/APP want to use the local API function need connect to the same network as the smart AP.

End user

This API is capable of controlling a SmartAP in the local network .The end user must enable the activate local API setting in the SmartAP settings, found under "Preferences” → “Connection & APIs” →“Local API & SIP Configuration".
The end user needs an smart access point with version 6.36 or later.

To sum up, the end user/smart access point requirements are:

  • A smart access point with at least version 6.36 must be available

  • The system access point must enable the activate local API setting under“Preferences” → “Connection & APIs” →“Local API & SIP Configuration".

Account

Need enbale an user account to support API function.