Pruebas locales de la API
Cómo recibir callbacks de dispositivos en un equipo de desarrollo y probar los comandos REST con Postman antes de pasar a producción.
Pruebas locales (sin desplegar en un servidor)
Para probar su integración de callbacks desde su equipo de desarrollo local, sin desplegar en un servidor de producción, debe hacer que su equipo local sea accesible desde internet para que el Cams Protocol Engine pueda enviarle (POST) los datos del callback.
Opción A: IP pública + redirección de puertos
Si su conexión a internet tiene una dirección IP pública (estática), puede redirigir un puerto externo a su aplicación local.
Averigüe su IP pública
Visite whatismyip.com o ejecute curl ifconfig.me en su terminal. Anote su dirección IP pública.
Configure la redirección de puertos en su router
Inicie sesión en el panel de administración de su router. Redirija un puerto externo (p. ej. 8080) a la IP interna de su equipo local y al puerto en el que se ejecuta su aplicación (p. ej. 3000, 5000, 8080).
Configure la URL de callback
En API Monitor, establezca su URL de callback en:http://YOUR_PUBLIC_IP:8080/callback
Pruebe
Genere una marcación en el dispositivo biométrico. El Cams Protocol Engine enviará (POST) los datos del callback a su IP pública, que su router redirige a su aplicación local.
Opción B: Herramientas de túnel (sin IP pública)
Si no tiene una IP pública o no puede configurar la redirección de puertos, use un servicio de túnel para exponer su servidor local a internet.
| Herramienta | Comando | Notas |
|---|---|---|
| ngrok | ngrok http 3000 | Hay un plan gratuito disponible. Le da una URL HTTPS pública al instante. |
| Cloudflare Tunnel | cloudflared tunnel --url localhost:3000 | Gratis. No se necesita cuenta para túneles rápidos. |
| localhost.run | ssh -R 80:localhost:3000 ssh.localhost.run | Sin instalación. Funciona mediante SSH. |
Inicie su aplicación local
Ejecute su servidor de callbacks en local (p. ej. php -S localhost:8080 o node server.js o python app.py).
Inicie el túnel
Ejecute la herramienta de túnel. Mostrará una URL pública como https://abc123.ngrok-free.app.
Configure la URL de callback
En API Monitor, establezca la URL de callback con la URL del túnel:https://abc123.ngrok-free.app/callback
Pruebe
Genere una marcación. Los callbacks llegarán a su equipo local a través del túnel en tiempo real.
Prueba de URL
Antes de pasar a producción, verifique sus endpoints con Postman. Ofrecemos una colección lista para usar con las 27 operaciones RESTful preconfiguradas.
Colección de Postman
Descárguela e impórtela en Postman. Establezca las variables base_url, stgid y auth_token y empiece a probar de inmediato.
Importe la colección
Abra Postman → Import → arrastre y suelte el archivo .json descargado. Las 27 operaciones RESTful aparecen agrupadas por categoría.
Establezca sus variables
Vaya a la pestaña Variables de la colección y establezca:
base_url = la URL de su endpoint RESTful (de API Monitor)
stgid = el Service Tag ID de su dispositivo
auth_token = el AuthToken de su dispositivo
Envíe solicitudes
Seleccione cualquier operación, edite el cuerpo JSON con sus valores y pulse Send. Verifique que la respuesta coincida con el formato esperado documentado arriba.
Ejemplo en Postman
A continuación se muestra una captura de pantalla con una solicitud de API de ejemplo configurada en Postman. Establezca el método en POST, pegue la URL de su endpoint RESTful con ?stgid= y use un cuerpo raw JSON.
{"status":"done"} con HTTP 200.