Support Hub/API & Integrations/Cams-callback-URL's lokaal testen met ngrok
Translated from the English article and reviewed by a person. Read the English original
Developer

Cams-callback-URL's lokaal testen met ngrok

Cams-callback-URL's lokaal testen met ngrok

Voordat u uw integratie naar productie overzet, kunt u Cams API-callbacks rechtstreeks op uw ontwikkelcomputer testen met een tunneling-tool. Deze handleiding leidt u stap voor stap door de installatie.

Waarom u een tunnel nodig heeft

Callback- en webhookverzoeken komen via internet van het Cams-platform. Een lokale toepassing op uw computer kan deze verzoeken niet rechtstreeks ontvangen, omdat deze zich achter een firewall of NAT-netwerk bevindt.

Een tunneling-service creëert een beveiligd openbaar eindpunt dat inkomende verzoeken doorstuurt naar uw lokale toepassing.

Voordelen

  • Callbacks testen vóór implementatie
  • Webhook-payloads in realtime debuggen
  • Verwerking van verzoeken lokaal valideren
  • Ontwikkel- en implementatietijd verkorten

Aanbevolen tunneling-tools

ngrok instellen (aanbevolen)

Installatie

  1. Ga naar https://ngrok.com
  2. Download de versie die geschikt is voor uw besturingssysteem.
  3. Pak het bestand uit en installeer het uitvoerbare bestand.
  4. Maak een gratis account aan (optioneel, maar aanbevolen).
  5. Genereer een AuthToken.
  6. Configureer uw AuthToken.
    ngrok config add-authtoken YOUR_AUTHTOKEN

Een tunnel starten

Als ngrok al is geconfigureerd:
ngrok http 3000
Vervang 3000 door de poort van uw toepassing.

Voorbeelduitvoer

Forwarding https://abc123.ngrok-free.app -> http://localhost:3000
Uw toepassing is nu bereikbaar via de openbare HTTPS-URL.

Alternatief: gebruik de Cams Callback-testtool

U kunt ook het callback-testprogramma van Cams gebruiken.

  1. Installeer en pak de tool uit via onderstaande link.
    https://developer.camsbiometrics.com/setup/ngrok-helper-kit.rar
  2. Bewerk het bestand app.properties.
  3. Configureer:
    ngrok.auth.token=
    ngrok.tunnel.url=
  4. Voer uit:
    check_ngrok.bat

Het programma richt de tunnel automatisch in en vereenvoudigt het lokaal testen van callbacks.


Installatie van callback-integratie

Stap 1: Start uw lokale toepassing
Stap 2: Start de tunnel
Stap 3: Test de callback
Activeer een testgebeurtenis en controleer het volgende:

  • Uw toepassing ontvangt het callbackverzoek.
  • Verzoek-payloads worden correct verwerkt.
  • Er verschijnen geen fouten in de applicatielogs.
  • Verzoeken zijn zichtbaar in het tunneldashboard.

Best practices

  • Gebruik waar mogelijk HTTPS-callback-URL's.
  • Houd de tunnel tijdens het testen actief.
  • Controleer de applicatielogs op validatie van verzoeken.
  • Controleer of uw eindpunt de verwachte HTTP-responscodes retourneert.
  • Test foutafhandelingsscenario's voordat u naar productie gaat.

Belangrijke opmerkingen

  • Gratis ngrok-URL's veranderen telkens wanneer de tunnel opnieuw wordt gestart.
  • Betaalde ngrok-abonnementen ondersteunen gereserveerde domeinen en aangepaste subdomeinen.
  • Tijdelijke tunnels mogen alleen worden gebruikt voor ontwikkel- en testdoeleinden.

Conclusie

Het blootstellen van uw lokale server via een tunneling-service is de snelste manier om uw callback-URL te testen voordat u uw toepassing implementeert. Of u nu ngrok, Cloudflare Tunnel of localhost.run gebruikt, dit proces stelt u in staat realtime callbackverzoeken te ontvangen en uw integratie in een lokale ontwikkelomgeving te valideren.

Het volgen van bovenstaande stappen helpt een soepele overgang van ontwikkeling naar productie te waarborgen.

Was this article helpful?