Device Configuration Guide

This guide explains step-by-step how to configure your ZKTeco or compatible biometric hardware (PUSH / ADMS / WDMS SDK) to communicate directly with Biosyn Cloud Infrastructure.

Network & Port Requirements

To allow biometric devices to stream attendance logs and execute real-time commands, your server uses specific ports depending on the PUSH SDK protocol version running on your device firmware:

• Server IP / Host Address: Current Server IP (Configured in Server management)
• Protocol Version 3.x Port: 8088 (Dedicated port for PUSH 3.x controllers / devices)
• Protocol Version 2.x Port: 8089 (Dedicated port for Standalone PUSH 2.x devices)
• Protocol: HTTP / HTTPS

Checking Push Protocol Version on Hardware

Before configuring network settings, check your physical device firmware info to determine whether to use Port 8088 (3.x) or Port 8089 (2.x):

1. Press [MENU] / [M/OK] on the physical device keypad.
2. Navigate to:

   Main Menu > System Info > Firmware Info

3. Look for the Push Version or Firmware Version:
   • If version starts with 3.x (e.g. 3.1.1, 3.2.0), use Port 8088.
   • If version starts with 2.x (e.g. 2.0.1, 2.4.0), use Port 8089.

Step-by-Step Physical Device Setup

Follow these exact menu paths on your ZKTeco device display panel:

Step 1: Enable Network DHCP

Navigate to:

Main Menu > COMM. > Ethernet

Set the following parameter:

• DHCP: ON

Step 2: Configure Cloud Server Settings

Navigate to:

Main Menu > COMM. > Cloud Server Setting

Configure the following fields exactly as shown below:

Menu Field	Required Value	Description
Enable Domain Name	OFF	Keep OFF when connecting via Server IP address. Set ON only if using a domain name.
Server Address	Current Server IP	Enter your Biosyn Server IP address (e.g. 192.168.1.100 or server host IP).
Server Port	8088 or 8089	Enter 8088 for Protocol 3.x or 8089 for Protocol 2.x.
HTTPS	ON (if available)	Enable HTTPS encryption if supported by device firmware.

Save the settings and reboot or restart the network interface.

Registering Device in Biosyn

Before the device can stream data, register its Serial Number (SN) in the Biosyn Dashboard or via API:

Obtaining API Base URL & Location Token

Before sending REST requests, retrieve your API credentials:

1. Go to Organizations.
2. Select your location (e.g. Foo Location).
3. Navigate to Overview / API Access Tokens.
4. Copy your API Base URL and generate your API Token.

Via Location API

curl -X POST "https://<YOUR_SERVER_URL>/api/devices" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sn": "AFK921400123",
    "name": "Front Gate SpeedFace"
  }'

Automatic Device Handshake & Status

Once saved and configured, the physical device automatically initiates an encrypted handshake with the Biosyn server:

When connected successfully:

• Device status will display as Online in Biosyn.
• Heartbeats will automatically poll Biosyn for pending commands and real-time event sync.

Connection Verification Checklist

To confirm the device integration is operational:

• [x] Device display shows the Cloud / Web icon with a green checkmark or connected status.
• [x] Perform a test punch (Face / Fingerprint / Card).
• [x] Check the Biosyn Transaction Logs to verify real-time record delivery.