Integration guide

Connect ZKTeco attendance devices

Everything to prepare and configure, from the device menu to the first punch in 360PeopleForce. Plan about 15 minutes per site.

How it works

ZKTeco devices keep punches in their own memory. The 360PeopleForce ZKTeco Relay runs on one Windows computer in the same office, reads every device about once a minute and sends new punches to 360PeopleForce over HTTPS. One relay serves all the devices of a site.

If the internet or a device is down, punches stay on the device and are sent as soon as the connection is back. The relay remembers what it already sent, and 360PeopleForce ignores duplicates, so nothing is lost or counted twice.

1. Prepare in 360PeopleForce

Your 360PeopleForce administrator or our onboarding team sets this up, and gives you the company ID and the relay key for the site.

  • An attendance relay is created for each office or site. It comes with the company ID and a relay key (starts with pfr_). The key is shown only once, so keep it somewhere safe; it can be replaced (rotated) at any time.
  • Each device is registered with its serial number, IP address, port and comm key, marked as a check-in, check-out or both, and assigned to the relay of its site.
  • Employees use the same user ID on the device as their attendance ID in 360PeopleForce, so each punch is matched to the right person.

2. Prepare each device

On each ZKTeco device, check these settings. Menu names vary slightly between models.

IP addressMenu > Comm. > Ethernet. Give the device a fixed IP address (or a DHCP reservation on your router) so it does not change.
PortMenu > Comm. > PC Connection. Leave the default 4370 unless your network team needs another one.
Comm keyMenu > Comm. > PC Connection. A number that works like a password. Use the same value when the device is registered in 360PeopleForce; 0 means no key.
Date, time and time zoneMenu > System > Date Time. Punches carry the device time, so set it correctly or turn on network time.
Serial numberMenu > System Info > Device Info. Needed to register the device in 360PeopleForce.

3. Choose the relay computer

  • A Windows PC or server on the same network as the attendance devices, switched on during working hours
  • 64-bit Windows 10, Windows 11 or Windows Server 2016 or newer - nothing else to install
  • Administrator rights on that machine for the installation
  • Outbound HTTPS (port 443) to the 360PeopleForce API
  • Network access from that machine to each device on its SDK port (4370 by default)

To check a device is reachable, run this in PowerShell on that computer, using the device's IP address. It must say TcpTestSucceeded : True.

Test-NetConnection 192.168.1.201 -Port 4370

4. Install the relay

  1. 1

    Run the installer

    Open 360PeopleForce-ZKTecoRelay-Setup.exe and accept the Windows administrator prompt. If Windows SmartScreen shows "Windows protected your PC", choose More info, then Run anyway.

  2. 2

    Connect to 360PeopleForce

    Keep the server URL as it is, then paste the company ID and the relay key. The key is hidden while you type.

  3. 3

    Test

    Select Next. Setup checks the key with 360PeopleForce and shows your company, the relay and each device, with whether this computer can reach it.

  4. 4

    Install

    Select Install. The relay is installed as a Windows service and starts straight away. It starts again with Windows from now on.

For many sites, IT teams can install without the wizard:

360PeopleForce-ZKTecoRelay-Setup.exe /VERYSILENT /COMPANYID=<company-id> /RELAYKEY=<relay-key>

5. Check punches arrive

  • Start menu > 360PeopleForce ZKTeco Relay > Relay status (live): the service is running and every device is reachable.
  • Punch on a device. Within about a minute, Relay logs (live) shows the punch being sent.
  • The punch appears in 360PeopleForce attendance for that employee.

Load past punches

A new relay sends punches from the day it is installed. To bring in older punches still stored on a device, ask your 360PeopleForce administrator to run a history pull for that device and date range. The relay sends them in the background while new punches keep flowing. Pull only the period you need: a year of punches from a busy device can be tens of thousands.

Update, move or remove

  • Update: download and run the newest installer. Your settings and the punch progress are kept, so nothing is sent twice.
  • Change the company ID or relay key: Start menu > 360PeopleForce ZKTeco Relay > Change relay settings.
  • Move to another computer: uninstall it from the old computer first (a device serves one relay at a time), then install it on the new one with the same company ID and relay key.
  • Remove: Windows Settings > Apps > Installed apps > 360PeopleForce ZKTeco Relay > Uninstall.

Troubleshooting

The relay key was rejected

Copy the whole key again. If it was rotated or lost, rotate it again in 360PeopleForce and use the new key in Start menu > Change relay settings.

The company ID is not the relay's company

Use the company ID shown with the relay itself, not another company's.

A device is "not reachable from this computer"

Check the device is on and its IP address and port are right, then ping the device from the relay computer. A firewall or a different network (VLAN) between them is the usual cause.

Punches are not arriving

Open Start menu > Relay status (live). Check the service is running, the devices are reachable and there are no red lines in Relay logs (live).

Punches stop at night or at weekends

The computer went to sleep. Set Power options to never sleep, or install the relay on a computer that stays on.

Punches have the wrong time

Fix the date, time and time zone on the device. New punches use the corrected time.

Security and network

  • Outbound HTTPS only. No inbound port is opened on your network and no VPN is needed.
  • One key per site. Rotate it at any time; the old key stops working immediately.
  • The relay key is readable by Windows administrators only, and the devices' comm keys are also encrypted on disk.
  • It sends attendance punches only (the device, the user ID on the device, the time and how they punched), plus its version and computer name for support.

Need a hand?

Our team can join a call and set up the first site with you.

Contact us
Chat on WhatsApp