API Reference
Referensi endpoint sistem FREMIS-N — healthcheck, lisensi, verifikasi database, dan manajemen kredensial.
Enrollment
Endpoint pendaftaran identitas wajah dan manajemen variasi.
1:1 Match
Endpoint pencocokan dua foto wajah secara langsung.
1:N Search
Endpoint pencarian wajah terhadap seluruh database keyspace.
Keyspace
Endpoint manajemen namespace database FREMIS-N.
Cluster Sharding
Endpoint distribusi data dan statistik resource untuk deployment cluster.
Semua endpoint FREMIS-N memanggil service FREMIS-N pada basis URL yang dikonfigurasi melalui variabel FREMIS_N_API_URL. Visionaire4 dan Lenz juga mengonsumsi endpoint yang sama secara internal — Anda dapat memanggilnya langsung untuk integrasi kustom.
Autentikasi menggunakan access-key dan secret-key yang dikonfigurasi pada saat deployment FREMIS-N. Lihat Configuration Reference untuk detail manajemen kredensial.
System
Endpoint operasional untuk monitoring kesehatan, kuota lisensi, verifikasi database, dan manajemen kredensial. Gunakan endpoint ini untuk integrasi dengan sistem monitoring (Prometheus, Kubernetes probe) dan administrasi service.
Cek Kesehatan Service
Mengecek status kesehatan service FREMIS-N. Endpoint ini ideal untuk readiness dan liveness probe pada Kubernetes atau monitoring otomatis. Response kosong menunjukkan service sehat.
curl -X GET "https://fremis-n.example.com/v1/healthcheck"{}Mendapatkan Penggunaan Kuota Lisensi
Mengambil informasi penggunaan kuota lisensi FREMIS-N saat ini, termasuk jumlah enrollment, keyspace, dan anonymous enrollment yang digunakan. Gunakan untuk monitoring keperluan upgrade lisensi.
curl -X GET "https://fremis-n.example.com/v1/get-limit-usage"{ "current_enrollment": 500, "maximum_enrollment": 1000, "current_keyspace": 5, "maximum_keyspace": 10, "current_anonymous_enrollment": 50, "maximum_anonymous_enrollment": 100}Verifikasi Koneksi Database
Memverifikasi akses dan konektivitas ke database dengan kredensial yang diberikan. Endpoint ini adalah bagian dari proses setup awal FREMIS-N untuk memastikan konfigurasi database sudah benar.
Authorization
bearerAuth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://fremis-n.example.com/v1/verify-db" \ -H "Content-Type: application/json" \ -d '{ "name": "db_name", "oid": "object_id" }'{}Menyimpan Kredensial Lisensi
Menyimpan access key, secret key, dan deployment key dari Nodeflux ke konfigurasi lokal FREMIS-N, kemudian memicu reload service untuk menerapkan kredensial baru. Endpoint ini harus dipanggil saat setup awal atau pembaruan lisensi.
Authorization
bearerAuth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
text/plain
curl -X POST "https://fremis-n.example.com/v1/store-credentials" \ -H "Content-Type: application/json" \ -d '{ "access_key": "your_access_key", "secret_key": "your_secret_key", "deployment_key": "your_deployment_key" }'"Valid credentials are stored!"Mendapatkan Informasi Lisensi Aktif
Mengambil informasi lisensi FREMIS-N yang sedang aktif, termasuk deployment key, access key, dan sumber lisensi. Gunakan untuk verifikasi konfigurasi lisensi saat deployment atau troubleshooting.
curl -X GET "https://fremis-n.example.com/v1/license"{ "deployment_key": "key_here", "access_key": "access_here", "license_source": "cloud"}