API'yi yerel ortamda test etme
Yayına almadan önce geliştirme makinesinde cihaz callback'lerini nasıl alacağınız ve REST komutlarını Postman ile nasıl test edeceğiniz.
Yerel Test (Sunucuya Dağıtım Yapmadan)
Callback entegrasyonunuzu — üretim sunucusuna dağıtım yapmadan — yerel geliştirme makinenizden test etmek için, Cams Protocol Engine'in callback verisini POST edebilmesi amacıyla yerel makinenizi internetten erişilebilir hale getirmeniz gerekir.
Seçenek A: Herkese Açık IP + Port Yönlendirme
İnternet bağlantınızın herkese açık (statik) bir IP adresi varsa, harici bir portu yerel uygulamanıza yönlendirebilirsiniz.
Herkese açık IP'nizi bulun
whatismyip.com adresini ziyaret edin veya terminalinizde curl ifconfig.me komutunu çalıştırın. Herkese açık IP adresinizi not edin.
Yönlendiricinizde port yönlendirmeyi ayarlayın
Yönlendirici yönetim paneline giriş yapın. Harici bir portu (örn. 8080) yerel makinenizin iç IP'sine ve uygulamanızın çalıştığı porta (örn. 3000, 5000, 8080) yönlendirin.
Callback URL'sini yapılandırın
API Monitor'da Callback URL'nizi şu şekilde ayarlayın:http://YOUR_PUBLIC_IP:8080/callback
Test
Biyometrik cihazda bir okutma yapın. Cams Protocol Engine callback verisini herkese açık IP'nize POST eder; yönlendiriciniz bunu yerel uygulamanıza iletir.
Seçenek B: Tünelleme Araçları (Herkese Açık IP Gerekmez)
Herkese açık bir IP'niz yoksa veya port yönlendirmeyi yapılandıramıyorsanız, yerel sunucunuzu internete açmak için bir tünelleme hizmeti kullanın.
| Araç | Komut | Notlar |
|---|---|---|
| ngrok | ngrok http 3000 | Ücretsiz katman mevcut. Anında herkese açık bir HTTPS URL'si verir. |
| Cloudflare Tunnel | cloudflared tunnel --url localhost:3000 | Ücretsiz. Hızlı tüneller için hesap gerekmez. |
| localhost.run | ssh -R 80:localhost:3000 ssh.localhost.run | Kurulum yok. SSH üzerinden çalışır. |
Yerel uygulamanızı başlatın
Callback sunucunuzu yerel olarak çalıştırın (örn. php -S localhost:8080 veya node server.js veya python app.py).
Tüneli başlatın
Tünelleme aracını çalıştırın. https://abc123.ngrok-free.app gibi herkese açık bir URL üretir.
Callback URL'sini yapılandırın
API Monitor'da Callback URL'sini tünel URL'si olarak ayarlayın:https://abc123.ngrok-free.app/callback
Test
Bir okutma yapın. Callback'ler tünel üzerinden yerel makinenize gerçek zamanlı akar.
URL Testi
Yayına almadan önce uç noktalarınızı Postman ile doğrulayın. 27 RESTful işlemin tamamı önceden yapılandırılmış hazır bir koleksiyon sunuyoruz.
Postman Koleksiyonu
İndirin ve Postman'e aktarın. base_url, stgid ve auth_token değişkenlerini ayarlayın — ardından hemen test etmeye başlayın.
Koleksiyonu içe aktarın
Postman'i açın → Import → indirilen .json dosyasını sürükleyip bırakın. 27 RESTful işlemin tamamı kategoriye göre gruplanmış olarak görünür.
Değişkenlerinizi ayarlayın
Koleksiyonun Variables sekmesine gidin ve şunları ayarlayın:
base_url = RESTful uç nokta URL'niz (API Monitor'dan)
stgid = cihazınızın Service Tag ID'si
auth_token = cihazınızın AuthToken'ı
İstekleri gönderin
Herhangi bir işlemi seçin, JSON gövdesini kendi değerlerinizle düzenleyin ve Send'e basın. Yanıtın yukarıda belgelenen beklenen biçimle eşleştiğini doğrulayın.
Postman Örneği
Aşağıda Postman'de yapılandırılmış örnek bir API isteğini gösteren ekran görüntüsü yer alır. Yöntemi POST olarak ayarlayın, RESTful uç nokta URL'nizi ?stgid= ile yapıştırın ve ham JSON gövde kullanın.
{"status":"done"} döndürdüğünü doğrulayın.