Testarea API-ului local

Cum primiți callback-urile dispozitivelor pe un computer de dezvoltare și cum testați comenzile REST cu Postman înainte de implementare.

Testare locală (fără implementare pe un server)

Pentru a testa integrarea callback-urilor de pe computerul dumneavoastră local de dezvoltare — fără implementare pe un server de producție — trebuie să faceți computerul accesibil din internet, astfel încât Cams Protocol Engine să poată trimite prin POST datele callback către el.

Opțiunea A: IP public + redirecționare de porturi

Dacă conexiunea dumneavoastră la internet are o adresă IP publică (statică), puteți redirecționa un port extern către aplicația dumneavoastră locală.

1

Aflați IP-ul public

Vizitați whatismyip.com sau rulați curl ifconfig.me în terminal. Notați adresa IP publică.

2

Configurați redirecționarea de porturi pe router

Autentificați-vă în panoul de administrare al routerului. Redirecționați un port extern (de ex. 8080) către IP-ul intern al computerului dumneavoastră și portul pe care rulează aplicația (de ex. 3000, 5000, 8080).

3

Configurați Callback URL

În API Monitor, setați Callback URL la:
http://YOUR_PUBLIC_IP:8080/callback

4

Testare

Declanșați o pontare pe dispozitivul biometric. Cams Protocol Engine va trimite prin POST datele callback către IP-ul dumneavoastră public, pe care routerul îl redirecționează către aplicația locală.

Opțiunea B: instrumente de tunelare (fără IP public)

Dacă nu aveți un IP public sau nu puteți configura redirecționarea de porturi, folosiți un serviciu de tunelare pentru a expune serverul local în internet.

InstrumentComandăObservații
ngrokngrok http 3000Plan gratuit disponibil. Vă oferă instantaneu un URL HTTPS public.
Cloudflare Tunnelcloudflared tunnel --url localhost:3000Gratuit. Nu este necesar cont pentru tunelurile rapide.
localhost.runssh -R 80:localhost:3000 ssh.localhost.runFără instalare. Funcționează prin SSH.
1

Porniți aplicația locală

Rulați local serverul de callback (de ex. php -S localhost:8080 sau node server.js sau python app.py).

2

Porniți tunelul

Rulați instrumentul de tunelare. Acesta va afișa un URL public precum https://abc123.ngrok-free.app.

3

Configurați Callback URL

În API Monitor, setați Callback URL la URL-ul tunelului:
https://abc123.ngrok-free.app/callback

4

Testare

Declanșați o pontare. Callback-urile vor curge prin tunel către computerul dumneavoastră local, în timp real.

Important: URL-urile tunelurilor sunt temporare și se schimbă de fiecare dată când reporniți instrumentul (cu excepția cazului în care folosiți un plan plătit cu domenii rezervate). Actualizați Callback URL în API Monitor de fiecare dată când primiți un URL nou de tunel.
Testarea RESTful API nu necesită această configurare. Puteți apela endpoint-ul RESTful direct de pe computerul local, folosind Postman sau codul dumneavoastră — fără redirecționare de porturi sau tunelare. Doar Callback API (de intrare, de la Cams către serverul dumneavoastră) necesită ca mașina dumneavoastră să fie accesibilă din internet.

Testarea URL-ului

Înainte de a intra în producție, verificați endpoint-urile folosind Postman. Vă punem la dispoziție o colecție gata făcută, cu toate cele 27 de operațiuni RESTful preconfigurate.

Colecția Postman

Descărcați și importați în Postman. Setați variabilele base_url, stgid și auth_token — apoi începeți imediat testarea.

📥 Descărcați colecția Postman
1

Importați colecția

Deschideți Postman → Import → trageți și plasați fișierul .json descărcat. Toate cele 27 de operațiuni RESTful apar grupate pe categorii.

2

Setați variabilele

Mergeți la fila Variables a colecției și setați:
base_url = URL-ul endpoint-ului dumneavoastră RESTful (din API Monitor)
stgid = Service Tag ID al dispozitivului dumneavoastră
auth_token = AuthToken al dispozitivului dumneavoastră

3

Trimiteți cereri

Selectați orice operațiune, editați corpul JSON cu valorile dumneavoastră și apăsați Send. Verificați dacă răspunsul corespunde formatului așteptat, documentat mai sus.

Exemplu Postman

Mai jos este o captură de ecran cu o cerere API de exemplu configurată în Postman. Setați metoda la POST, lipiți URL-ul endpoint-ului dumneavoastră RESTful cu ?stgid= și folosiți un corp raw JSON.

Captură de ecran Postman care arată configurarea unei cereri Cams API
Testați și endpoint-ul Callback. Trimiteți prin POST un JSON RealTimePunchLog de exemplu (vezi Op #11) către Callback URL și verificați că serverul dumneavoastră returnează {"status":"done"} cu HTTP 200.