Menguji API secara lokal

Cara menerima callback perangkat di mesin pengembangan dan menguji perintah REST dengan Postman sebelum Anda melakukan deploy.

Informasi Tambahan

Pengujian Lokal (Tanpa Deploy ke Server)

Untuk menguji integrasi callback dari mesin pengembangan lokal Anda — tanpa deploy ke server produksi — Anda perlu membuat mesin lokal dapat dijangkau dari internet agar Cams Protocol Engine dapat mengirim POST data callback ke sana.

Opsi A: IP Publik + Port Forwarding

Jika koneksi internet Anda memiliki alamat IP publik (statis), Anda dapat meneruskan port eksternal ke aplikasi lokal Anda.

Cari IP publik Anda

Kunjungi whatismyip.com atau jalankan curl ifconfig.me di terminal Anda. Catat alamat IP publik Anda.

Siapkan port forwarding di router Anda

Masuk ke panel admin router Anda. Teruskan port eksternal (mis. 8080) ke IP internal mesin lokal Anda dan port tempat aplikasi Anda berjalan (mis. 3000, 5000, 8080).

Konfigurasikan Callback URL

Di API Monitor, atur Callback URL Anda ke:
http://YOUR_PUBLIC_IP:8080/callback

Uji

Lakukan absen pada perangkat biometrik. Cams Protocol Engine akan mengirim POST data callback ke IP publik Anda, yang diteruskan router ke aplikasi lokal Anda.

Opsi B: Alat Tunneling (Tanpa IP Publik)

Jika Anda tidak memiliki IP publik atau tidak dapat mengonfigurasi port forwarding, gunakan layanan tunneling untuk mengekspos server lokal Anda ke internet.

Alat	Perintah	Catatan
ngrok	`ngrok http 3000`	Tersedia paket gratis. Langsung memberi URL HTTPS publik.
Cloudflare Tunnel	`cloudflared tunnel --url localhost:3000`	Gratis. Tidak perlu akun untuk quick tunnel.
localhost.run	`ssh -R 80:localhost:3000 ssh.localhost.run`	Tanpa instalasi. Bekerja melalui SSH.

Jalankan aplikasi lokal Anda

Jalankan server callback Anda secara lokal (mis. php -S localhost:8080 atau node server.js atau python app.py).

Mulai tunnel

Jalankan alat tunneling. Alat ini akan menampilkan URL publik seperti https://abc123.ngrok-free.app.

Konfigurasikan Callback URL

Di API Monitor, atur Callback URL ke URL tunnel:
https://abc123.ngrok-free.app/callback

Uji

Lakukan absen. Callback akan mengalir melalui tunnel ke mesin lokal Anda secara real-time.

Penting: URL tunnel bersifat sementara dan berubah setiap kali Anda memulai ulang alat (kecuali Anda memakai paket berbayar dengan domain khusus). Perbarui Callback URL di API Monitor setiap kali Anda mendapat URL tunnel baru.

Pengujian API RESTful tidak memerlukan pengaturan ini. Anda dapat memanggil endpoint RESTful langsung dari mesin lokal menggunakan Postman atau kode Anda — tanpa port forwarding atau tunneling. Hanya API Callback (masuk dari Cams ke server Anda) yang mengharuskan mesin Anda dapat dijangkau dari internet.

Informasi Tambahan

Pengujian URL

Sebelum go-live, verifikasi endpoint Anda menggunakan Postman. Kami menyediakan koleksi siap pakai dengan semua 27 operasi RESTful yang sudah dikonfigurasi.

Koleksi Postman

Unduh dan impor ke Postman. Atur variabel base_url, stgid, dan auth_token — lalu langsung mulai menguji.

📥 Unduh Koleksi Postman

Impor koleksi

Buka Postman → Import → seret dan lepas file .json yang diunduh. Semua 27 operasi RESTful muncul dikelompokkan per kategori.

Atur variabel Anda

Buka tab Variables pada koleksi dan atur:
base_url = URL endpoint RESTful Anda (dari API Monitor)
stgid = Service Tag ID perangkat Anda
auth_token = AuthToken perangkat Anda

Kirim permintaan

Pilih operasi apa pun, edit body JSON dengan nilai Anda, lalu klik Send. Pastikan respons sesuai dengan format yang didokumentasikan di atas.

Contoh Postman

Berikut tangkapan layar yang menampilkan contoh permintaan API yang dikonfigurasi di Postman. Atur metode ke POST, tempel URL endpoint RESTful Anda dengan ?stgid=, dan gunakan body raw JSON.

Tangkapan layar Postman yang menampilkan konfigurasi permintaan Cams API

Uji juga endpoint Callback Anda. POST contoh JSON RealTimePunchLog (lihat Op #11) ke Callback URL Anda dan pastikan server Anda mengembalikan {"status":"done"} dengan HTTP 200.