Enable driver check-in and check-out

Driver identification actions allow drivers to check-in and check-out directly on a device via QR code, or with a five digit PIN code.

Once a driver checks in, all trips, recordings, events, and data are associated with the driver. The driver may check-out through the device, or be checked out through the API. If a new driver checks in while the device is associated with another driver, the previous driver is checked out.

A record of the driver is available in the Surfsight portal, and relevant information is recorded in the cloud and retrievable by API. This feature can be enabled through the Surfsight portal or API.

The rest of this guide shows you how to use the Surfsight API to manage driver identification capabilities and review the associated event data, following these steps:

1. Authenticate yourself.
2. Enable driver check-in
3. Create driver 4Retrieve driving history

1. Authenticate yourself

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

2. Enable driver check-in

Enable driver identification check-in with a five digit driver PIN code or QR code with the following calls:

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

Once driver check-in is enabled, a driver check-in icon appears on the device screen.

curl -i -X PUT \
https://api-prod.surfsight.net/v2/devices/:imei/device-config \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{ 
},
    "pinCodeDi": {
      "value": true
    },
    "qrDi": {
      "value": false
    },
    "driverIdentification": {
      "driverPrompt": true,
      "audioAlert": true,
      "driverPromptDurationSeconds": 30
    },

Returned response:

{
  "requestId": "requestId" 
}

3. Create driver

Create a driver with the POST /drivers call.

curl -i -X POST \
 'https://api-prod.surfsight.net/v2/drivers?organizationId=17' \
 -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
 -H 'Content-Type: application/json' \
 -d '{
  "data": [
    {
      "organizationId": 17,
      "driverThirdPartyId": "50729123",
      "drivingLicense": "10203040",
      "firstName": "John",
      "lastName": "Doe"
    }
  ]
},

Returned response:

{
  "requestId": "requestId"
}

4. Retrieve driving history

Driving history can be retrieved with the GET /driving-history call. Information is available in the metadata of the event.

curl -i -X GET \
  'https://api-prod.surfsight.net/v2/driving-history?driverThirdPartyId=50729123&imei=12345678&start=2020-01-01T14%3A48%3A00.000Z&end=2020-01-01T14%3A48%3A00.000Z&sort=createdAt&order=asc&offset=1&limit=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
  

The returned response:

{
"data": [
{
"driverHistory": [
{
"driver": {
"id": "qwerty12345",
"driverThirdPartyId": "50729123",
"drivingLicense": "10203040",
"firstName": "John",
"lastName": "Doe",
"driverCode": "12345",
"imei": "357660101000198",
"isActive": true
},
"startTime": "2021-12-14T12:42:04.323Z",
"endTime": "2021-12-14T14:09:53.876Z"
}
]
}
]
}