Support Hub/API & Integrations/Menguji URL Callback Cams Secara Lokal dengan ngrok
Translated from the English article and reviewed by a person. Read the English original
Developer

Menguji URL Callback Cams Secara Lokal dengan ngrok

Menguji URL Callback Cams Secara Lokal dengan ngrok

Sebelum memindahkan integrasi Anda ke produksi, Anda dapat menguji callback Cams API secara langsung di mesin pengembangan Anda menggunakan alat tunneling. Panduan ini memandu Anda melalui pengaturan langkah demi langkah.

Mengapa Anda memerlukan tunnel

Permintaan callback dan webhook berasal dari platform Cams melalui internet. Aplikasi lokal yang berjalan di mesin Anda tidak dapat menerima permintaan ini secara langsung karena berada di balik firewall atau jaringan NAT.

Layanan tunneling membuat endpoint publik yang aman yang meneruskan permintaan masuk ke aplikasi lokal Anda.

Manfaat

  • Menguji callback sebelum deployment
  • Men-debug payload webhook secara real time
  • Memvalidasi penanganan permintaan secara lokal
  • Mengurangi waktu pengembangan dan deployment

Alat Tunneling yang Direkomendasikan

Mengatur ngrok (direkomendasikan)

Instalasi

  1. Kunjungi https://ngrok.com
  2. Unduh versi yang sesuai dengan sistem operasi Anda.
  3. Ekstrak dan instal file executable.
  4. Buat akun gratis (opsional tetapi direkomendasikan).
  5. Buat AuthToken.
  6. Konfigurasi AuthToken Anda.
    ngrok config add-authtoken YOUR_AUTHTOKEN

Memulai Tunnel

Jika ngrok sudah dikonfigurasi:
ngrok http 3000
Ganti 3000 dengan port aplikasi Anda.

Contoh Output

Forwarding https://abc123.ngrok-free.app -> http://localhost:3000
Aplikasi Anda sekarang dapat diakses melalui URL HTTPS publik.

Alternatif: Gunakan Alat Pengujian Callback Cams

Anda juga dapat menggunakan utilitas pengujian callback yang disediakan oleh Cams.

  1. Instal dan ekstrak alat menggunakan tautan berikut.
    https://developer.camsbiometrics.com/setup/ngrok-helper-kit.rar
  2. Edit file app.properties.
  3. Konfigurasi:
    ngrok.auth.token=
    ngrok.tunnel.url=
  4. Jalankan:
    check_ngrok.bat

Utilitas ini akan secara otomatis membuat tunnel dan menyederhanakan pengujian callback lokal.


Pengaturan Integrasi Callback

Langkah 1: Jalankan Aplikasi Lokal Anda
Langkah 2: Jalankan Tunnel
Langkah 3: Uji Callback
Picu event uji contoh dan verifikasi hal-hal berikut:

  • Aplikasi Anda menerima permintaan callback.
  • Payload permintaan berhasil diproses.
  • Tidak ada error yang muncul di log aplikasi.
  • Permintaan terlihat di dashboard tunnel.

Praktik Terbaik

  • Gunakan URL callback HTTPS whenever possible.
  • Pertahankan tunnel tetap aktif selama pengujian.
  • Tinjau log aplikasi untuk validasi permintaan.
  • Verifikasi bahwa endpoint Anda mengembalikan kode respons HTTP yang diharapkan.
  • Uji skenario penanganan error sebelum memindahkan ke produksi.

Catatan Penting

  • URL ngrok gratis berubah setiap kali tunnel dimulai ulang.
  • Paket ngrok berbayar mendukung domain yang dicadangkan dan subdomain kustom.
  • Tunnel sementara hanya boleh digunakan untuk tujuan pengembangan dan pengujian.

Kesimpulan

Membuka server lokal Anda melalui layanan tunneling adalah cara tercepat untuk menguji URL callback Anda sebelum mendeploy aplikasi. Baik Anda menggunakan ngrok, Cloudflare Tunnel, maupun localhost.run, proses ini memungkinkan Anda menerima permintaan callback real time dan memvalidasi integrasi Anda di lingkungan pengembangan lokal.

Mengikuti langkah-langkah di atas akan membantu memastikan transisi yang lancar dari pengembangan ke deployment produksi.

Was this article helpful?