Integration Overview
zPatrol can automatically populate incident form fields using data retrieved from your system when an RFID, barcode, or QR code is scanned (or manually entered, if enabled). Your system must:
• Provide API access to the required data
• Be reachable over the Internet
• Support standard or custom authentication methods
zPatrol sends HTTPS requests (JSON preferred, XML supported) to your API and maps the returned key-value pairs directly to corresponding form fields.
IP Whitelisting
For secure operation, we recommend whitelisting zPatrol’s IP addresses to allow our application to communicate with your Barcode/RFID API. This ensures protected data exchange and reliable performance.
zPatrol uses three isolated environments—Production, Evaluation, and Development—each with redundant IPs for high availability. All IPs originate from secure AWS Internet Gateways and are used only by the application and authorized developers.
How it Works
zPatrol can automatically fill form fields with data pulled from your system whenever an RFID, barcode, or QR code is scanned (or manually entered, if enabled). To enable this, your system must provide API access to the required data, be reachable over the internet, and support either standard or custom authentication methods.
When a scan occurs, zPatrol sends a secure HTTPS request (JSON preferred, XML supported) to your API and maps the returned key-value pairs to the corresponding form fields.
This functionality involves a one-time onboarding fee and requires development work during setup to connect your third-party system. Once implemented, mapping each data point is simple:
- Open the form in the Form Builder.
- Click the Actions icon (three dots in a circle) next to the field you want to map and select Edit Field.
- In the Edit Field window, open the Map Data Keys tab.
- Use the RFID or Barcode Scanning dropdown to select the API data key that matches the value for that field.
After mapping your fields, add a Scan button at the start of your form to prompt patrollers to scan a barcode or RFID card for each guest. Drag and drop this button into your form like any other field. Once added, a large scan button will appear during form entry. When a scan is successful, all mapped fields will automatically populate with the guest’s data, saving patrollers significant time on data collection.
