Dokumentasi integrasi
Hubungkan aplikasi
dengan API wajah.
Daftar akun untuk aplikasi Anda, buat API key dari dashboard, lalu simpan key di backend. Kirim key lewat header X-API-Key pada setiap request ke /v1/.
API key adalah credential server. Jangan menyematkannya ke JavaScript browser, aplikasi mobile, URL, atau repository.
Aplikasi, sekolah, dan orang
Satu akun aplikasi memiliki tenant sendiri. Buat collection untuk setiap sekolah; daftarkan siswa atau guru sebagai subject di collection tersebut. external_id dapat berisi ID dari aplikasi Anda.
Buat koleksi sekolah
POST /v1/collectionsMultipart field: name. Simpan collection_id dari respons untuk request berikutnya.
Daftarkan orang dan sampel pertama
POST /v1/collections/{collection_id}/subjectsMultipart field: name, image, dan external_id opsional. Simpan subject_id. Maksimal 10 sampel wajah per subject.
Cari wajah dalam sekolah
POST /v1/collections/{collection_id}/searchMultipart field: image. Respons berisi kandidat subject, similarity, dan keputusan match untuk wajah yang terdeteksi.
Verifikasi satu orang
POST /v1/collections/{collection_id}/subjects/{subject_id}/verifyMultipart field: image. Cocokkan selfie dengan sampel milik subject yang ditentukan.
Bandingkan dua foto
POST /v1/faces/compareMultipart field: image1 dan image2. Setiap foto harus berisi tepat satu wajah.
Contoh request
Contoh berikut memakai placeholder credential dan collection ID, bukan key yang bisa dipakai.
curl -H 'X-API-Key: API_KEY_ANDA' \ -H 'Idempotency-Key: daftar-siswa-001' \ -F name='Nama siswa' \ -F external_id='SISWA-001' \ -F image=@foto.jpg \ 'BASE_URL/v1/collections/COLLECTION_ID/subjects'
Ganti BASE_URL dengan alamat server layanan, serta key dan collection ID milik aplikasi Anda.
Kuota dan retry
Kuota default 100.000 operasi per tenant per hari, reset pukul 00.00 WIB. Detect, compare, enroll, penambahan sampel, verify, dan search yang berhasil memakai satu unit per request. Search berulang untuk orang yang sama tetap memakai unit.
Gunakan Idempotency-Key yang sama saat mengulang aksi dengan payload yang sama. Hasil sukses dapat direplay selama 24 jam tanpa unit tambahan. Key sama dengan payload atau resource berbeda menghasilkan 409.
Membaca hasil
Similarity bukan probabilitas identitas. Threshold saat ini belum dikalibrasi untuk semua kondisi sekolah. liveness: not_checked berarti layanan belum memeriksa apakah wajah berasal dari orang sungguhan di depan kamera.
Gunakan JPEG atau PNG hingga 4 MB dan 12 megapixel. Foto asli diproses sementara; enrollment menyimpan embedding sebagai data biometrik.