Tester l’API en local
Comment recevoir les callbacks des terminaux sur une machine de développement et tester les commandes REST avec Postman avant le déploiement.
Tests en local (sans déploiement sur un serveur)
Pour tester votre intégration de callback depuis votre machine de développement locale — sans déployer sur un serveur de production — vous devez rendre votre machine accessible depuis Internet afin que le Cams Protocol Engine puisse y envoyer (POST) les données de callback.
Option A : IP publique + redirection de port
Si votre connexion Internet dispose d’une adresse IP publique (fixe), vous pouvez rediriger un port externe vers votre application locale.
Trouvez votre IP publique
Rendez-vous sur whatismyip.com ou exécutez curl ifconfig.me dans votre terminal. Notez votre adresse IP publique.
Configurez la redirection de port sur votre routeur
Connectez-vous à l’interface d’administration de votre routeur. Redirigez un port externe (par ex. 8080) vers l’IP interne de votre machine locale et le port sur lequel tourne votre application (par ex. 3000, 5000, 8080).
Configurez l’URL de callback
Dans l’API Monitor, définissez votre URL de callback sur :http://YOUR_PUBLIC_IP:8080/callback
Test
Déclenchez un pointage sur le terminal biométrique. Le Cams Protocol Engine enverra (POST) les données de callback à votre IP publique, que votre routeur redirige vers votre application locale.
Option B : outils de tunneling (aucune IP publique requise)
Si vous n’avez pas d’IP publique ou ne pouvez pas configurer la redirection de port, utilisez un service de tunneling pour exposer votre serveur local sur Internet.
| Outil | Commande | Remarques |
|---|---|---|
| ngrok | ngrok http 3000 | Offre gratuite disponible. Fournit instantanément une URL HTTPS publique. |
| Cloudflare Tunnel | cloudflared tunnel --url localhost:3000 | Gratuit. Aucun compte requis pour les tunnels rapides. |
| localhost.run | ssh -R 80:localhost:3000 ssh.localhost.run | Aucune installation. Fonctionne via SSH. |
Démarrez votre application locale
Lancez votre serveur de callback en local (par ex. php -S localhost:8080 ou node server.js ou python app.py).
Démarrez le tunnel
Lancez l’outil de tunneling. Il affichera une URL publique du type https://abc123.ngrok-free.app.
Configurez l’URL de callback
Dans l’API Monitor, définissez l’URL de callback sur l’URL du tunnel :https://abc123.ngrok-free.app/callback
Test
Déclenchez un pointage. Les callbacks transiteront par le tunnel jusqu’à votre machine locale en temps réel.
Test d’URL
Avant la mise en production, vérifiez vos points de terminaison avec Postman. Nous fournissons une collection prête à l’emploi avec les 27 opérations RESTful préconfigurées.
Collection Postman
Téléchargez-la et importez-la dans Postman. Définissez les variables base_url, stgid et auth_token — puis commencez à tester immédiatement.
Importez la collection
Ouvrez Postman → Import → glissez-déposez le fichier .json téléchargé. Les 27 opérations RESTful apparaissent regroupées par catégorie.
Définissez vos variables
Allez dans l’onglet Variables de la collection et définissez :
base_url = l’URL de votre point de terminaison RESTful (depuis l’API Monitor)
stgid = le Service Tag ID de votre terminal
auth_token = l’AuthToken de votre terminal
Envoyez des requêtes
Sélectionnez une opération, modifiez le corps JSON avec vos valeurs, puis cliquez sur Send. Vérifiez que la réponse correspond au format attendu documenté ci-dessus.
Exemple Postman
La capture d’écran ci-dessous montre un exemple de requête d’API configurée dans Postman. Réglez la méthode sur POST, collez l’URL de votre point de terminaison RESTful avec ?stgid= et utilisez un corps raw JSON.
{"status":"done"} avec HTTP 200.