Local API

Local API memungkinkan aplikasi Anda sendiri mengendalikan Q-Booth yang sedang berjalan lewat HTTP — dari PC yang sama atau perangkat lain di jaringan lokal. Mulai event, bawa tamu melewati sesi foto, cetak, tampilkan kode QR, dan baca posisi booth kapan saja.

Memulai

1. Buka jendela Pengaturan Aplikasi, masuk ke Lanjutan → Local API, lalu nyalakan Aktifkan Local API. (Jika Lanjutan tidak terlihat, aktifkan dulu Tampilkan semua pengaturan.)
2. Biarkan Kata sandi kosong agar dibuatkan otomatis, atau ketik sendiri. Port bawaan adalah 8730.
3. Untuk memanggilnya dari perangkat lain, nyalakan Izinkan perangkat lain di jaringan. Windows mungkin sekali meminta izin agar Q-Booth bisa melewati firewall — izinkan.
4. Klik Simpan Pengaturan, lalu Buka halaman uji. Halaman uji berisi tombol untuk setiap perintah, plus salinan referensi ini dari booth itu sendiri.

Alamatnya http://<pc-booth>:8730 (http://localhost:8730 di PC booth itu sendiri). Semua perintah ada di bawah /api/v1/.

curl http://localhost:8730/api/v1/status -H "Authorization: Bearer KATA_SANDI_ANDA"

Kata sandi

Setiap panggilan kecuali GET /api/v1/commands membutuhkan kata sandi. Kirim dengan salah satu cara berikut:

• Authorization: Bearer <kata sandi> (disarankan)
• X-QBooth-Key: <kata sandi>
• ?key=<kata sandi> di URL, untuk alat yang hanya bisa membuka tautan

Kata sandi salah atau tidak ada akan dijawab 401. Sepuluh percobaan salah dalam satu menit dari satu alamat akan diblokir selama satu menit (429). Kata sandi ini adalah kunci operator — siapa pun yang memilikinya bisa mengendalikan booth, jadi jaga kerahasiaannya.

Balasan

Pembacaan memakai GET dan dijawab 200 beserta datanya:

{ "ok": true, "data": { ... } }

Aksi memakai POST dengan body JSON (atau query string). GET juga bisa, untuk alat pemicu yang hanya bisa mengirim GET. Aksi yang diterima dijawab 202 begitu booth menerimanya — tidak menunggu foto, cetakan, atau tamu:

{ "ok": true, "accepted": "camera/capture" }

Panggilan yang ditolak menyebutkan alasannya, dengan kode yang bisa Anda tindak lanjuti:

{ "ok": false, "error": { "code": "wrong_page", "message": "The booth is on the welcome page. This needs the Camera page." } }

API tidak pernah mengantrekan perintah untuk nanti. Jika booth tidak dalam kondisi yang mengizinkan, perintah langsung ditolak. Pesan error selalu dalam bahasa Inggris; gunakan code untuk logika aplikasi Anda.

Status

GET /api/v1/status memberi tahu posisi booth. Panggil berkala untuk mengikuti apa yang terjadi setelah sebuah aksi — setiap 300 sampai 1000 ms sudah cukup. Jika panggilan sama sekali tidak bisa terhubung, Q-Booth tidak berjalan (atau Local API mati).

{
  "app":     { "name": "QBooth", "version": "5.9.1.0", "apiVersion": "1" },
  "event":   { "id": "1781706869_H5A4", "name": "Wedding" },
  "page":    "camera",
  "session": { "active": true, "templateId": "…", "templateName": "Strip 3" },
  "camera":  { "phase": "review", "shot": 3, "shots": 3, "captured": 3, "feed": "live", "retakesLeft": 1 },
  "result":  null,
  "busy":    { "dialog": false, "processing": false },
  "available": ["camera/retake", "camera/process", "session/end", "event/stop"]
}

Satu tamu, langkah demi langkah

Alur umum, setiap langkah menunggu halaman atau fase yang tertera di status:

Perintah

Semua path diawali /api/v1/. index dimulai dari 1, sesuai urutan kartu yang dilihat tamu (galeri kiri atas lebih dulu). Kirim id atau index, bukan keduanya; kalau keduanya dikirim, yang dipakai id.

Error

Log

Setiap panggilan dicatat di folder log aplikasi, log\local_api\, satu file per hari: alamat pemanggil, perintah dan parameternya, jawaban, serta alasan penolakan. Kata sandi tidak pernah dicatat. Pemanggilan status yang berhasil tidak dicatat.

Riwayat versi