fingerprint-soap v1.0.1
Fingerprint SOAP
A NodeJS Package to communicate with the standalone fingerprint machine through its SOAP interface. Compatible with ZKTeco and Solution biometric products that have webserver feature.
Install
npm install fingerprint-soap
Usage
const FPSoap = require('fingerprint-soap')
const fp = new FPSoap('192.168.1.1')
fp.getUserInfo(2376).then(console.log)
async function getAllLog() {
const logs = await fp.getAttLog()
console.log(logs)
}
getAllLog()
API Documentation
FingerprintSOAP
Kind: global class
- FingerprintSOAP
- new FingerprintSOAP(host, port, comKey, timeout)
- .getUserInfo(userId) ⇒ Promise
- .getAllUserInfo() ⇒ Promise
- .deleteUser(userId) ⇒ Promise
- .getUserTemplate(userId, fingerId) ⇒ Promise
- .getAttLog([userId]) ⇒ Promise
- .clearAttLog() ⇒ Promise
- .makeRequest(command, args) ⇒ Promise
- .parseResponse(response, command) ⇒ Object | Array | null
- .generateXMLContent(command, jsonData) ⇒ string
new FingerprintSOAP(host, port, comKey, timeout)
FingerprintSOAP constructor
Param | Type | Default | Description |
---|---|---|---|
host | string | device IP address | |
port | number | 80 | device port (default 80) |
comKey | number | 0 | device communication key/password (default 0) |
timeout | number | 5000 | connection timeout in milliseconds |
fingerprintSOAP.getUserInfo(userId) ⇒ Promise
Get user information by user id from device
Kind: instance method of FingerprintSOAP Returns: Promise - Object user data { PIN, Name, Password, Group, Privilege, Card, PIN2, TZ1, TZ2, TZ3 }
Param | Type | Description |
---|---|---|
userId | number | user ID |
fingerprintSOAP.getAllUserInfo() ⇒ Promise
Get all users in device
Kind: instance method of FingerprintSOAP Returns: Promise - array of users { PIN, Name, Password, Group, Privilege, Card, PIN2, TZ1, TZ2, TZ3 }, ...
fingerprintSOAP.deleteUser(userId) ⇒ Promise
Delete user from device
Kind: instance method of FingerprintSOAP Returns: Promise - boolean true if success
Param | Type | Description |
---|---|---|
userId | number | user ID |
fingerprintSOAP.getUserTemplate(userId, fingerId) ⇒ Promise
Get a fingerprint template of user
Kind: instance method of FingerprintSOAP Returns: Promise - Object user data with template { PIN, FingerID, Size, Valid, Template }
Param | Type | Description |
---|---|---|
userId | number | user ID |
fingerId | number | finger index |
fingerprintSOAP.getAttLog(userId) ⇒ Promise
Read out the attendance record from device
Kind: instance method of FingerprintSOAP Returns: Promise - array attendance data {PIN: 2376, DateTime(yyyy-mm-dd hh:mm:ss), Verified, Status, WorkCode }, ...
Param | Type | Description |
---|---|---|
userId | number | user ID. If empty, get all users log |
fingerprintSOAP.clearAttLog() ⇒ Promise
Delete all attendance record from attendance device
Kind: instance method of FingerprintSOAP Returns: Promise - boolean true if success
fingerprintSOAP.makeRequest(command, args) ⇒ Promise
Make SOAP request to device
Kind: instance method of FingerprintSOAP Returns: Promise - string raw response
Param | Type | Description |
---|---|---|
command | string | request command (pascal case) |
args | Object | request parameters |
fingerprintSOAP.parseResponse(response, command) ⇒ Object | Array | null
Parse XML response into javascript object
Kind: instance method of FingerprintSOAP Return: any - object/array/null
Param | Type | Description |
---|---|---|
response | string | raw response |
command | string | request command |
fingerprintSOAP.generateXMLContent(command, jsonData) ⇒ string
Generate XML string from command and parameters
Kind: instance method of FingerprintSOAP Returns: string - XML formatted string
Param | Type | Description |
---|---|---|
command | string | request command |
jsonData | Object | request parameters |