Lewati ke konten utama

Fingerspot Developer API

Selamat datang di Fingerspot Developer API — REST API untuk mengontrol perangkat biometrik Fingerspot (sidik jari, wajah, vein) dari klien HTTP apa pun.

Pola Respons​

Operasi sinkron (get_attlog, get_device) mengembalikan payload lengkap langsung di body respons HTTP.

Operasi asinkron mengembalikan konfirmasi {"success": true, "trans_id": "..."} secara langsung dan mengirimkan hasil aktualnya melalui callback HTTP POST berformat JSON ke URL webhook yang dikonfigurasi untuk perangkat target. Nilai trans_id pada callback selalu sama dengan trans_id yang dikirim pada permintaan awal, sehingga klien dapat mengaitkan callback dengan permintaan yang sesuai.

Diagram Alur Asinkron

URL Webhook​

Setiap perangkat memiliki URL webhook yang didaftarkan di platform. Callback untuk operasi asinkron dikirimkan melalui POST ke URL tersebut. URL webhook dikembalikan dalam respons get_device dan dapat diperbarui melalui portal pelanggan.

PropertiNilai
Base URLhttps://developer.fingerspot.io
Formatapplication/json
AutentikasiBearer Token
Retry WebhookDapat dikonfigurasi

Push Attlog Real-time​

Selain callback perintah-respons, platform secara terus-menerus mengirimkan event pemindaian kehadiran real-time (type: "attlog") ke URL webhook setiap perangkat setiap kali perangkat mengirim hasil pemindaian — terlepas dari panggilan API apa pun.

Tipe Event Webhook​

Webhook mengirimkan callback untuk semua operasi asinkron, bukan hanya attlog:

Event TypeDeskripsi
attlogEvent absensi real-time (pemindaian sidik jari/wajah/vein)
get_userinfoHasil query informasi user dari perangkat
get_userid_listHasil query daftar user ID yang terdaftar
set_timeKonfirmasi sinkronisasi waktu perangkat
set_userinfoKonfirmasi update/tambah info user
delete_userinfoKonfirmasi penghapusan user dari perangkat

Setiap callback memiliki field type yang mendeskripsikan jenis event, cloud_id untuk identifikasi perangkat, dan trans_id untuk korelasi dengan permintaan asli.