Ikhtisar API Integrasi

Setiap unit ARSA AI Box Series menjalankan dasbornya sendiri, dan dasbor itu memiliki REST API untuk sistem Anda yang lain: ERP, sistem manajemen gedung, pusat manajemen lalu lintas, alat BI atau skrip Anda sendiri. API berjalan di perangkat itu sendiri, di jaringan Anda. Tidak ada cloud ARSA di antaranya: sistem Anda memanggil perangkat, dan perangkat memanggil sistem Anda bila Anda berlangganan webhook.

Dua API Di Setiap Perangkat

• API platform (/api/v1) sama di setiap produk: lokasi dan zonanya, kamera, peringatan, video langsung dan rekaman, kontak dan webhook peringatan, sirene dan relai, laporan, serta webhook untuk integrator.
• API produk berada di sampingnya dan memuat angka milik produk tersebut:

Satu perangkat menjalankan satu produk, sehingga perangkat melayani API platform dan API produk tersebut. Id lokasi dan kamera sama di keduanya.

Contoh Panggilan

curl --cacert box.pem \
  -H "Authorization: Bearer <API_KEY>" \
  "https://<BOX_HOST>/api/v1/sites"

<BOX_HOST> adalah alamat tempat Anda membuka dasbor. <API_KEY> adalah token akun API yang dibuat Admin di dasbor. Perangkat memakai sertifikatnya sendiri; box.pem adalah salinannya, yang diunduh Admin di dasbor (Sistem, lalu Akun API, lalu Unduh sertifikat perangkat) beserta sidik jarinya untuk diperiksa (Sertifikat Perangkat).

Langkah Berikutnya

• Autentikasi dan Cakupan: akun API, token, cakupan, data pribadi, batas laju dan galat.
• Panduan mulai cepat: Basic Safety Guard, Traffic Monitor, Smart Retail Counter dan DOOH Audience Meter.
• Webhook: peristiwa deteksi, ringkasan dan peringatan yang dikirim ke sistem Anda, serta cara memverifikasi tanda tangannya.
• Referensi setiap operasi: platform, Basic Safety Guard, Traffic Monitor, Smart Retail Counter dan DOOH Audience Meter.

Versi

Dokumentasi ini menjelaskan API versi 1.0.0. Versi menjadi bagian dari setiap path (/api/v1, /api/<product>/v1). Dalam satu versi mayor, perubahan hanya berupa tambahan: operasi baru, kolom opsional baru dan nilai baru. Perubahan yang dapat merusak integrasi datang dengan versi mayor baru, yang dilayani berdampingan dengan versi lama selama masa transisi. Bacalah kolom yang Anda kenal dan abaikan yang tidak Anda kenal, agar tambahan tidak memengaruhi Anda.

Yang Tetap Dilakukan Oleh Orang

Sebagian tindakan tetap dilakukan oleh orang yang masuk ke dasbor dan ditolak untuk token API: masuk, pengguna dan akun API, lisensi, pembaruan, akses jarak jauh, pengaturan privasi, basis data wajah dan saluran notifikasi. Kunci dan token umpan mesin (kiriman daftar pantau, umpan POS dan log tayang, umpan DATEX II dan audiens) juga dibuat di dasbor oleh Admin lokasi.