Langkah Awal

Ikuti langkah-langkah ini untuk mengirim permintaan API pertama Anda.

Langkah 1 — Prasyarat

• Perangkat Fingerspot yang terhubung ke platform
• cloud_id yang ditetapkan ke perangkat Anda
• Token API Anda (Bearer token)

Langkah 2 — Permintaan Sinkron

Beberapa endpoint mengembalikan data secara langsung. Contoh: dapatkan info perangkat:

curl -X POST https://developer.fingerspot.io/api/get_device \
  -H "Authorization: Bearer your-api-token" \
  -H "Content-Type: application/json" \
  -d '{"trans_id": "1", "cloud_id": "XXXXX"}'

Respons:

{
  "success": true,
  "trans_id": "1",
  "data": {
    "cloud_id": "XXXXX",
    "device_name": "device 1",
    "webhook_url": "https://yourserver.example.com/webhook",
    "created_at": "2025-01-01 13:00:00",
    "last_activity": "N/A"
  }
}

Langkah 3 — Permintaan Asinkron

Untuk operasi asinkron, API mengembalikan konfirmasi secara langsung. Hasil aktual dikirimkan melalui webhook ke URL yang dikonfigurasi perangkat Anda:

curl -X POST https://developer.fingerspot.io/api/get_userinfo \
  -H "Authorization: Bearer your-api-token" \
  -H "Content-Type: application/json" \
  -d '{"trans_id": "1", "cloud_id": "XXXXX", "pin": "1"}'

Respons ack:

{
  "success": true,
  "trans_id": "1"
}

Callback webhook tiba di URL terdaftar Anda dengan trans_id yang sesuai dengan permintaan (request) pada langkah 2:

{
  "type": "get_userinfo",
  "cloud_id": "XXXXX",
  "trans_id": "1",
  "data": {
    "pin": "1",
    "name": "john",
    "privilege": "1",
    "finger": "1",
    "face": "0",
    "password": "111",
    "rfid": "",
    "vein": "0",
    "template": "5345dsfd33242423asdas"
  }
}

Contoh Webhook Lainnya

Attlog (Event Absensi Real-time)

Event absensi dikirim secara realtime setiap kali user melakukan pemindaian. Tidak ada trans_id karena event ini tidak dipicu oleh API call.

{
  "type": "attlog",
  "cloud_id": "XXXXX",
  "data": {
    "pin": "1",
    "scan": "2020-07-21 10:11",
    "verify": "1",
    "status_scan": "0"
  }
}

Field	Deskripsi
pin	User ID
scan	Waktu pemindaian (YYYY-MM-DD HH:mm)
verify	Metode verifikasi: 1=finger, 2=password, 3=card, 4=face, 6=vein
status_scan	Status: 0=scan in, 1=scan out, 2=break in, 3=break out

Get User ID List

Hasil query daftar semua user ID yang terdaftar di perangkat:

{
  "type": "get_userid_list",
  "cloud_id": "XXXXX",
  "trans_id": "1",
  "data": {
    "total": 3,
    "pin_arr": ["1", "2", "3"]
  }
}

Field	Deskripsi
total	Jumlah total user yang terdaftar
pin_arr	Array berisi semua user ID

URL Webhook

Setiap perangkat memiliki URL webhook yang dikonfigurasi. Callback untuk operasi asinkron dikirimkan melalui POST ke URL tersebut. Anda dapat melihat dan memperbaruinya melalui portal pelanggan atau API get_device.