De API lokaal testen
Hoe u apparaatcallbacks op een ontwikkelmachine ontvangt en REST-opdrachten met Postman test voordat u live gaat.
Lokaal testen (zonder uitrol op een server)
Om uw callback-integratie vanaf uw lokale ontwikkelmachine te testen — zonder uitrol op een productieserver — moet u uw lokale machine bereikbaar maken vanaf internet, zodat de Cams Protocol Engine callbackgegevens ernaartoe kan POSTen.
Optie A: openbaar IP-adres + portforwarding
Als uw internetverbinding een openbaar (statisch) IP-adres heeft, kunt u een externe poort doorsturen naar uw lokale applicatie.
Uw openbare IP-adres opzoeken
Ga naar whatismyip.com of voer curl ifconfig.me uit in uw terminal. Noteer uw openbare IP-adres.
Portforwarding instellen op uw router
Log in op het beheerpaneel van uw router. Stuur een externe poort (bijv. 8080) door naar het interne IP-adres van uw machine en de poort waarop uw applicatie draait (bijv. 3000, 5000, 8080).
De Callback-URL configureren
Stel in de API Monitor uw Callback-URL in op:http://YOUR_PUBLIC_IP:8080/callback
Testen
Activeer een registratie op het biometrische apparaat. De Cams Protocol Engine POST de callbackgegevens naar uw openbare IP-adres, dat uw router doorstuurt naar uw lokale applicatie.
Optie B: tunneltools (geen openbaar IP-adres nodig)
Als u geen openbaar IP-adres hebt of geen portforwarding kunt configureren, gebruikt u een tunneldienst om uw lokale server bloot te stellen aan internet.
| Tool | Opdracht | Opmerkingen |
|---|---|---|
| ngrok | ngrok http 3000 | Gratis versie beschikbaar. Geeft u direct een openbare HTTPS-URL. |
| Cloudflare Tunnel | cloudflared tunnel --url localhost:3000 | Gratis. Voor snelle tunnels is geen account nodig. |
| localhost.run | ssh -R 80:localhost:3000 ssh.localhost.run | Geen installatie. Werkt via SSH. |
Uw lokale applicatie starten
Start uw callbackserver lokaal (bijv. php -S localhost:8080 of node server.js of python app.py).
De tunnel starten
Start de tunneltool. Deze geeft een openbare URL weer, zoals https://abc123.ngrok-free.app.
De Callback-URL configureren
Stel in de API Monitor de Callback-URL in op de tunnel-URL:https://abc123.ngrok-free.app/callback
Testen
Activeer een registratie. Callbacks stromen realtime via de tunnel naar uw lokale machine.
URL-test
Controleer uw endpoints met Postman voordat u live gaat. Wij bieden een kant-en-klare collectie met alle 27 RESTful bewerkingen vooraf geconfigureerd.
Postman-collectie
Download de collectie en importeer deze in Postman. Stel de variabelen base_url, stgid en auth_token in — en begin direct met testen.
De collectie importeren
Open Postman → Import → sleep het gedownloade .json-bestand erheen. Alle 27 RESTful bewerkingen verschijnen gegroepeerd per categorie.
Uw variabelen instellen
Ga naar het tabblad Variables van de collectie en stel in:
base_url = uw RESTful endpoint-URL (uit de API Monitor)
stgid = de Service Tag ID van uw apparaat
auth_token = de AuthToken van uw apparaat
Requests versturen
Selecteer een bewerking, pas de JSON-body aan met uw waarden en klik op Send. Controleer of de response overeenkomt met het hierboven beschreven formaat.
Postman-voorbeeld
Hieronder ziet u een screenshot van een voorbeeld-API-request in Postman. Stel de methode in op POST, plak uw RESTful endpoint-URL met ?stgid= en gebruik een onbewerkte JSON-body.
{"status":"done"} met HTTP 200 teruggeeft.