Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

For organizations with Premium and Enterprise software licenses and the Rules Engine, the VRP/VIRP Video Reader Pro/Video Intercom Reader Pro can read QR codes and pass that information over webhook to any specified 3rd party system. This can allow systems that normally require a dedicated kiosk to scan their QR codes to do so at an entry, easily forwarding those details back into the system that originally generated and utilizes that QR code.

Enable QR Code Recognition

For the Video Reader Pro or Video Intercom Reader Pro to be able to pick up QR codes shown to them, an administrator will first need to enable this setting under the device's Video configuration page. By allowing this setting, the device will now be watching for QR codes in its view. The device will take no action until a specific set of actions is configured through the Rules Engine (requires a Premium/Enterprise software package).
To enable QR code recognition go to Devices > Video Reader or Video Intercom Readers > click on the device and select Video from the top nav bar and toggle the Enable QR code recognition

Iframe
allowfullscreentrue
srchttps://info.openpath.com/hubfs/Openpath/images/kustomer-articles/enable_QR_code.png
width699
frameborderhide
titleenable qr code
alignleft
height459
longdescEnable QR code recognition

Rules Engine Configuration

The Rules Engine now has a Trigger Event available to the Video Reader Pro and Video Intercom Reader Pro devices called “QR Code Read”. This trigger will fire any time the camera of those devices recognizes a QR code in its field of vision.

Iframe
allowfullscreentrue
srchttps://info.openpath.com/hubfs/Openpath/images/kustomer-articles/qr_code_trigger.png
width700
frameborderhide
titletrigger event
alignleft
height387
longdescQR Code Trigger Event

Optionally a Condition may be added to specify that this event fires only when seen by a specific device in the Org.

Iframe
allowfullscreentrue
srchttps://info.openpath.com/hubfs/Openpath/images/kustomer-articles/qr_conditions.png
width700
frameborderhide
titleQR conditions
alignleft
height242
longdescQR Code Rules Condition

The intended Action for use with this feature is a Webhook. The URL specified should point to a 3rd party system that is programmed to accept incoming webhooks from Atla Access and be able to parse the information provided to the system.

Iframe
allowfullscreentrue
srchttps://info.openpath.com/hubfs/Openpath/images/kustomer-articles/qr_webhook.png
width700
frameborderhide
titleqr_webhook
alignleft
height408
longdescQR Code Webhook

If you choose POST in the above HTTP method, the decoded QR code(s) will be sent as JSON in the HTTP request body. To configure that, select POST, you can leave Post fields empty and hit save.

Iframe
allowfullscreentrue
srchttps://info.openpath.com/hubfs/Openpath/images/kustomer-articles/qr_http_post.png
width700
frameborderhide
titleqr code http method
alignleft
height201
longdescQR Code HTTP POST method

Then click Use JSON editor.

Iframe
allowfullscreentrue
srchttps://info.openpath.com/hubfs/Openpath/images/kustomer-articles/qr_json.png
width700
frameborderhide
titleqr json
alignleft
height446
longdescQR Code use JSON editor

Inside the httpParams part, add "body": "{{json event}}" and save.

Iframe
allowfullscreentrue
srchttps://info.openpath.com/hubfs/Openpath/images/kustomer-articles/qr_json_edit.png
width700
frameborderhide
titleQR edit JSON
alignleft
height301
longdescEdit JSON

The output of the QR Code Read event webhook includes the event name, time of the event, and data of the event. The QR code read data includes the parsed QR code string as well as the detail of which Alta Access ACU device this event was related to.

Code Block
languagejson
{
    "event": "opvideoDevice.qrCode.detected",
    "timestamp": 1699390723.60129,
    "data": {
        "qrCodes": [
            "http://en.m.wikipedia.org "
        ],
        "acu": {
            "id": 17444,
            "name": "Test Video Intercom",
            "opal": "opal:sandbox:helium:alpha:302:acu:17444"
        },
        "gatewayDevice": {
            "name": "Test Video Intercom",
            "opal": "opal:sandbox:helium:alpha:302:acu:17444",
            "type": "acu",
            "uid": "17444"
        },
        "opvideoDeviceId": 62,
        "org": {
            "id": 302,
            "name": "IMVP2 Dev Org",
            "opal": "opal:sandbox:helium:alpha:302:org:302"
        },
        "sourceDevice": {
            "opal": "opal:sandbox:helium:alpha:302:opvideoDevice:62",
            "type": "opvideoDevice",
            "uid": "62"
        }
    }
} 

The inclusion of the Event detail is intended to provide a 3rd party system with its own integration with Alta Access, a method for referring back to the specific ACU so (as an example) the 3rd Party system can validate the QR code sent to it was a guest who’s QR code is still active and then send an unlock request through an existing integration that system may have with Alta Access.

QR code reads do not show up within the Alta Access Activity Logs, as the QR code read itself will not perform any action on an Entry within the site. There is no action taken by the Alta Access system beyond forwarding the QR code. Any subsequent actions would need to come from the programming of an integrated system with Alta Access or utilization of the Alta Access API integration to cause specific actions to occur within the Alta Access system as a result of the QR code scanned.