Scan a QR code and review event data

Scanning a QR code on documents and goods allows users to pair metadata with the event's time and location, and can be configured to include a video or snapshot. This feature supports workflows in external applications by scanning items such as health certifications, proof of delivery, approvals, and other documentation.

The rest of this guide shows you how to use the Surfsight API to enable and scan a QR code, and review the associated event data following these steps:

1. Authenticate yourself.
2. Enable the QR code event
3. Scan a QR code
4. Retrieve QR code scan event information

1. Authenticate yourself

Authenticate yourself before making any calls with the Surfsight API. For more details on authentication, see our authentication overview.

2. Enable the QR code event

Enable the QR code event with the following calls:

• PUT /devices/{imei}/event-config for an individual device
• PUT /devices/event-config for bulk configurations
• POST /organizations/{orgId}/event-settings for default settings for devices in an organization

Once the QR code event is enabled, a QR code icon appears on the device screen.

    curl --request PUT 'https://api-prod.surfsight.net/v2/devices/{imei}/event-config
    --header 'Content-Type: application/json'
    --header 'Authorization: Bearer {token}'
  --data-raw '{
    "vehicleType": "Private",
    "events": 
      {
        "eventType": "qrCode",
        "dataType": "none",
        "visualAlert": true,
        "audioAlert": true
      }
  }'

Returned response:

{
  "requestId": {"requestId"}
}

3. Scan a QR code

1. Press the QR code icon at the top left of the device screen. The device beeps for ten seconds or until a QR code is scanned.
2. Within ten seconds, scan the QR code using the in-cab lens. An event is triggered and sent to the cloud, with the QR code as metadata. A success message is displayed on the device screen.

4. Retrieve QR code scan event information

Event data can be retrieved with the GET devices/{imei}/events call. Information from the QR code scan is available in the metadata of the event. Event data also includes a timestamp, and video or snapshot, if configured.

curl --request GET 'https://api-prod.surfsight.net/v2/devices/{imei}/events'
--header 'Authorization: Bearer {token}'

The returned response:

{
  "id": 247195378,
  "eventType": "qrCode",
  "metadata": "{\"code\":\"Shipment delivered id_4081337\"}",
  "lat": 32.98581475,
  "lon": 35.14809606,
  "time": "2022-01-05T07:06:19.000Z",
  "files": [
    {
      "cameraId": 1,
      "fileId": "1641366379",
      "fileType": "video"
    }
  ]
}