REST API FACEIO

Panggil REST API FACEIO dari backend privat Anda untuk mengelola Facial ID, membandingkan gambar wajah, memperkirakan usia dan gender, memperbarui payload dan PIN Code, melihat statistik, serta memeriksa status API.

BUKA KONSOL FACEIO

Buat aplikasi di FACEIO Console, lalu ambil kunci API privatnya dari Application Manager. Simpan kunci tersebut hanya di backend.

REST API FACEIO

Endpoint HTTP backend untuk manajemen Facial ID, verifikasi wajah, dan operasi aplikasi

Setiap aplikasi FACEIO secara otomatis diberikan kunci API. Anda dapat mengambil kunci ini dari Application Manager di FACEIO Console ↗. Kunci API privat ini memungkinkan backend Anda memanggil REST API FACEIO dari bahasa pemrograman apa pun yang mendukung HTTPS.

  • Menggunakan kemampuan HTTP standar untuk meneruskan parameter dan autentikasi kunci API.
  • Mengembalikan kode respons HTTP standar untuk menunjukkan status berhasil dan error.
  • Selalu mengembalikan JSON untuk setiap permintaan, apa pun hasilnya.

Pemberitahuan Penting

Pemanggilan API dan instansiasi Widget melalui library JavaScript fio.js merupakan alur terpisah. Pendaftaran dan autentikasi berlangsung di sisi klien, di browser pengguna. Pemanggilan REST API harus berasal dari backend privat aplikasi Anda dan dapat dikenai kuota atau pembatasan laju sesuai paket Anda. Jika Anda baru menggunakan FACEIO, mulai dari Mulai, lalu gunakan Panduan Integrasi. Lihat tabel harga untuk melihat batas kuota REST API.

URL Dasar REST API

  • Endpoint dasar API FACEIO berada di https://api.faceio.net/.
  • Skema URL permintaan adalah https://api.faceio.net/cmd?param=val&param2=val2 dengan cmd adalah endpoint API dan param=val nilai tersebut adalah parameter endpoint. Setiap bagian endpoint di bawah mencantumkan metode HTTP yang didukung.
  • Pantau kesehatan dan status API secara real-time di status.faceio.net ↗.
Ringkasan API
URL Dasar api.faceio.net
Endpoint Pemeriksaan Kesehatan api.faceio.net/status ↗
Arsitektur RESTful
Versi HTTP dan TLS HTTP/1.1, HTTP/2, HTTP/3; TLS 1.2 dan 1.3
Autentikasi Berbasis Kunci ↓
Jaringan Cloudflare
Jenis MIME Respons HTTP application/json
Kode Status HTTP Lihat di bawah ↓

Ambil Kunci API Anda

Saat membuat aplikasi FACEIO baru, Anda secara otomatis diberikan kunci API. Ikuti langkah berikut untuk mengambil dan mengelola kunci Anda:

  1. 1 Masuk ke FACEIO Console ↗.
  2. 2 Buka Application Manager.
  3. 3 Pilih aplikasi yang ingin Anda kelola.
  4. 4 Klik tab Kunci API .
  5. ✓ Salin kunci API untuk panggilan HTTP dari server Anda. Tab yang sama menampilkan statistik dan informasi kuota API.

Autentikasi

Anda melakukan autentikasi ke endpoint API FACEIO dengan menyematkan kunci API Anda pada permintaan HTTP masuk. Lihat bagian di atas untuk mengetahui cara mengambil dan mengelola Kunci API ini.

Metode Autentikasi

Kirim kunci API dengan salah satu metode yang didukung berikut:

Header HTTP

Sematkan Kunci API Anda pada WWW-Authenticate header HTTP:

WWW-Authenticate: Bearer API_KEY
Parameter Query

Atau tambahkan kunci ke POST atau GET URL permintaan:

https://api.faceio.net/endpoint?param=val&key=API_KEY

Peringatan Keamanan: Jaga kunci API Anda tetap aman. Jangan pernah mengeksposnya di kode sisi klien, repositori publik, JavaScript browser, bundle aplikasi seluler, log, atau alat analitik. Gunakan hanya skrip sisi server yang berwenang dan tinjau panduan praktik terbaik keamanan sebelum digunakan di produksi.

Respons, Status & Kode Error HTTP

Berikut kode status HTTP dikembalikan untuk setiap permintaan. Semua Endpoint API mengembalikan application/json terlepas dari berhasil atau gagal. Tangani kegagalan secara eksplisit di backend sebelum memberikan akses, memperbarui data pengguna, atau mempercayai status Facial ID.

200 Berhasil. Endpoint API berhasil menjalankan operasi.
400 Bad Request. Biasanya menunjukkan parameter wajib tidak ada.
401 Tidak Diizinkan. Kunci API tidak ada atau tidak valid.
404 Tidak Ditemukan. Item yang diminta, misalnya Facial ID) tidak ada.
405 Metode Tidak Diizinkan. Endpoint ini tidak menangani metode HTTP tersebut.
429 Terlalu Banyak Permintaan. Batas laju terlampaui. Lihat Tabel Harga untuk melihat batas kuota.
500 Terjadi error internal pada server atau pemeliharaan sedang berlangsung.

Dokumentasi Endpoint

DELETEFACIALID

GET
URL Akses Endpoint https://api.faceio.net/deletefacialid
Deskripsi

Hapus Facial ID dan data payload terkait dari aplikasi FACEIO Anda. Operasi ini juga menginstruksikan mesin pengenalan wajah yang dipilih untuk menghapus hash biometrik terkait.

Facial ID adalah pengidentifikasi unik (UUID) yang ditetapkan secara anonim kepada setiap pengguna terdaftar. Pendaftaran dilakukan dengan memanggil metode enroll() dari library fio.js di sisi klien.

Ketersediaan Semua Paket
Metode HTTP GET

Parameter HTTP

Kolom Tipe Wajib Deskripsi
key HEX String YA Kunci REST API aplikasi Anda.
fid String YA Target Facial ID yang ingin Anda hapus (purge).

Respons HTTP

application/json

Endpoint API ini selalu mengembalikan objek JSON. Kolom berikut dikembalikan:

Kolom Tipe Deskripsi
status Integer Kode status HTTP standar: 200 jika berhasil; jika tidak, status error seperti 401.
payload Boolean TRUE jika Facial ID dan datanya berhasil dihapus. FALSE jika tidak.
Contoh Kode Penghapusan Facial ID (Python)

CHECKFACIALID

GET
URL Akses Endpoint https://api.faceio.net/checkfacialid
Deskripsi

Periksa apakah Facial ID terdaftar pada aplikasi FACEIO yang terkait dengan kunci API yang diberikan.
Ketersediaan Hanya Paket Berbayar/Upgrade. Lihat halaman harga untuk detail selengkapnya.
Metode HTTP GET

Parameter HTTP

Kolom Tipe Wajib Deskripsi
key HEX String YA Kunci REST API aplikasi Anda.
fid String YA Target Facial ID yang akan diverifikasi.

Respons HTTP

application/json

Endpoint API ini selalu mengembalikan objek JSON. Kolom berikut dikembalikan:

Kolom Tipe Deskripsi
status Integer Kode status HTTP standar: 200 jika berhasil; jika tidak, status error.
valid Boolean TRUE jika Facial ID valid dan terdaftar. FALSE jika tidak.
Contoh Kode Validasi Facial ID (Python)

FACE-VERIFY

POST
URL Akses Endpoint https://api.faceio.net/faceverify
Deskripsi

Bandingkan Dua Gambar Wajah

Endpoint faceverify membandingkan wajah dalam dua gambar dan mengembalikan hasil pencocokan serta skor kemiripan.

Kirim gambar sumber dan target yang masing-masing berisi satu wajah. Pendaftaran FACEIO sebelumnya tidak diperlukan. Backend Anda harus menentukan cara menggunakan skor yang dikembalikan dalam alurnya sendiri.

Catatan Privasi: Pemrosesan berlangsung di memori (RAM). Gambar dihapus segera setelah analisis. Tidak ada data yang dicatat atau disimpan. Tinjau praktik terbaik privasi sebelum menambahkan verifikasi wajah ke alur produksi.
Ketersediaan Hanya Paket Berbayar/Upgrade. Lihat halaman harga untuk detail selengkapnya.
Metode HTTP POST

Parameter HTTP

Kolom Tipe Wajib Deskripsi
key HEX String YA Kunci REST API aplikasi Anda.
src Base64 | URL YA Gambar sumber. Harus berupa string berkode Base64 dalam format data URI atau URL yang dapat diakses publik. Pastikan gambar hanya berisi satu wajah.
target Base64 | URL YA Gambar target yang akan dibandingkan dengan sumber. Harus berupa string berkode Base64 dalam format data URI atau URL yang dapat diakses publik.

Respons HTTP

application/json

Endpoint API ini selalu mengembalikan objek JSON. Kolom berikut dikembalikan:

Kolom Tipe Deskripsi
status Integer Kode status HTTP standar: 200 jika berhasil; jika tidak, status error.
same_person Boolean TRUE jika wajah sumber dan target milik orang yang sama. FALSE jika tidak.
dist Float Skor kemiripan jarak dari 0 hingga 1. Nilai yang mendekati 1 menunjukkan kemungkinan lebih tinggi bahwa wajah berasal dari orang yang sama.
sim Float Skor kemiripan cosine (0 hingga 1). Nilai yang mendekati 1 menunjukkan kemiripan lebih tinggi.
Contoh Kode Face Verify (Python)

AGE-CHECK

POST
URL Akses Endpoint https://api.faceio.net/agecheck
Deskripsi

Estimasi Usia dan Gender

Endpoint agecheck mengembalikan estimasi usia dan gender untuk wajah dalam gambar. Enrollment FACEIO sebelumnya tidak diperlukan. Perlakukan usia sebagai perkiraan, bukan bukti identitas, usia pasti, atau keputusan kelayakan hukum.

Catatan Privasi: Pemrosesan berlangsung di memori (RAM). Gambar dihapus segera setelah analisis. Tidak ada data yang dicatat atau disimpan. Tinjau praktik terbaik privasi sebelum menambahkan estimasi usia dan gender ke alur produksi.
Ketersediaan Hanya Paket Berbayar/Upgrade. Lihat halaman harga untuk detail selengkapnya.
Metode HTTP POST

Parameter HTTP

Kolom Tipe Wajib Deskripsi
key HEX String YA Kunci REST API aplikasi Anda.
img Base64 | URL YA Gambar input yang berisi wajah untuk dianalisis. Format: data:{MIME_type};base64,{data} atau URL yang dapat diakses publik.

Respons HTTP

application/json

Endpoint API ini selalu mengembalikan objek JSON. Kolom berikut dikembalikan:

Kolom Tipe Deskripsi
status Integer Kode status HTTP standar: 200 jika berhasil; jika tidak, status error.
age Integer Perkiraan usia orang dalam gambar.
gender String Estimasi gender orang dalam gambar.
Contoh Estimasi Usia dan Gender (Python)

SETFACIALIDPAYLOAD

POST
URL Akses Endpoint https://api.faceio.net/setfacialidpayload
Deskripsi

Atur atau ubah data payload yang terkait dengan pengguna terdaftar tertentu melalui Facial ID.

Payload tersimpan dikembalikan ke situs web atau aplikasi web Anda melalui fio.js setelah autentikasi pengguna berikutnya berhasil. Gunakan untuk data aplikasi minimal, seperti ID pengguna internal. Jangan sertakan rahasia atau keputusan otorisasi dalam payload.
Ketersediaan Hanya Paket Berbayar/Upgrade. Lihat halaman harga untuk detail selengkapnya.
Metode HTTP POST

Parameter HTTP

Kolom Tipe Wajib Deskripsi
key HEX String YA Kunci REST API aplikasi Anda.
fid String YA Target Facial ID untuk diperbarui.
payload String/Data Mentah YA Data payload baru yang akan dikaitkan dengan Facial ID. Data ini dikembalikan saat autentikasi berikutnya. Gunakan string, JSON, atau format payload lain milik backend.

Respons HTTP

application/json
Kolom Tipe Deskripsi
status Integer Kode status HTTP standar: 200 jika berhasil; jika tidak, status error.
payload Boolean TRUE jika payload berhasil diperbarui. FALSE jika tidak.

SETFACIALIDPINCODE

POST
URL Akses Endpoint https://api.faceio.net/setfacialidpincode
Deskripsi

Atur atau ubah kode PIN yang terkait dengan pengguna terdaftar tertentu pada aplikasi FACEIO Anda.
Ketersediaan Hanya Paket Berbayar/Upgrade. Lihat halaman harga untuk detail selengkapnya.
Metode HTTP POST

Parameter HTTP

Kolom Tipe Wajib Deskripsi
key HEX String YA Kunci REST API aplikasi Anda.
fid String YA Target Facial ID untuk diperbarui.
pin Number YA kode PIN baru untuk dikaitkan dengan Facial ID. Pengguna harus mengonfirmasi PIN ini saat diminta pada autentikasi berikutnya. PIN harus berisi minimal 4 dan maksimal 16 digit.

Respons HTTP

application/json

Endpoint API ini selalu mengembalikan objek JSON. Kolom berikut dikembalikan:

Kolom Tipe Deskripsi
status Integer Kode status HTTP standar. 200 menunjukkan berhasil.
payload Boolean TRUE jika kode PIN berhasil diperbarui. FALSE jika tidak.
Contoh Kode Perubahan PIN (Python)

STAT

GET
URL Akses Endpoint https://api.faceio.net/stat
Deskripsi

Kumpulkan analitik dan statistik untuk aplikasi FACEIO Anda, termasuk total wajah terindeks, panggilan API, dan enrollment terbaru. Catatan: statistik di-cache dan diperbarui setiap 5 menit.
Ketersediaan Hanya Paket Berbayar/Upgrade. Lihat halaman harga untuk detail selengkapnya.
Metode HTTP GET

Parameter HTTP

Kolom Tipe Wajib Deskripsi
key HEX String YA Kunci REST API aplikasi Anda.

Respons HTTP

application/json

Endpoint API ini selalu mengembalikan objek JSON. Kolom berikut dikembalikan:

Kolom Tipe Deskripsi
status Integer Kode status HTTP standar: 200 jika berhasil; jika tidak, status error seperti 401.
total_api_calls Integer Jumlah kumulatif panggilan API yang dibuat aplikasi ini.
total_indexed_faces Integer Jumlah total wajah unik yang saat ini terdaftar/terindeks.
last_indexed_faces Array Daftar berisi Facial ID pengguna yang paling baru terdaftar.

ABOUT

GET
URL Akses Endpoint https://api.faceio.net/about
Deskripsi

Ambil informasi versi dan pemberitahuan hak cipta dari instance FACEIO API yang sedang berjalan.
Ketersediaan Semua Paket
Metode HTTP GET

Parameter HTTP

Tidak ada parameter yang diperlukan.

Respons HTTP

application/json
Kolom Tipe Deskripsi
status Integer Kode status HTTP standar: 200 jika berhasil; jika tidak, status error.
payload String String versi server dan pemberitahuan hak cipta.

STATUS

GET
URL Akses Endpoint https://api.faceio.net/status
Deskripsi

Periksa status kesehatan server API FACEIO. Riwayat status real-time juga tersedia di status.faceio.net ↗.
Ketersediaan Semua Paket
Metode HTTP GET

Parameter HTTP

Tidak ada parameter yang diperlukan.

Respons HTTP

application/json
Kolom Tipe Deskripsi
status Integer 200 menunjukkan status operasional (System OK). 500 menunjukkan pemeliharaan atau gangguan layanan.
error String Pesan error jika status != 200.
payload String Pesan status, misalnya, "System OK".

Hubungkan Backend Anda ke REST API

Buat aplikasi FACEIO, ambil kunci REST API privat dari Console, lalu panggil endpoint terdokumentasi dari backend. Jangan pernah mengekspos kunci API dalam kode browser atau aplikasi seluler.

Baca Panduan Mulai → Buka FACEIO Console
Akurasi LFW 99,7%