ClearPath GPS Integration

ClearPath GPS is an API integration that includes the following features:

What You Need to Know

ClearPath GPS Support is happy to help undertake these configuration steps.

For assistance, please email support@clearpathgps.com or call (805) 979 3442.

Integration Setup

Steps 1, 2, and 3 are performed in Fleetio by the Account Owner

1. Create an API Key and Account Token
   • Follow the Fleetio API Keys guide to generate a key and access your account token. Name the key ClearPathGPS.
   • Make a note of the API Key and Account Token; you will need these in steps 5, 6, and 7.
2. Create External Vehicle ID

Create an External Vehicle ID in Fleetio:

1. Go to your Account Menu and select Settings.

2. In the Settings Sidebar, click External Vehicle IDs in the Vehicles section.
3. Click + Add External Vehicle ID in the top right:

4. In the Label field, enter "ClearPathGPS". In the Description field, enter "ClearPathGPS Vehicle ID" as shown below:

5. Click the Save button when finished.

3. Assign Fleetio Vehicles to ClearPathGPS External Vehicle ID

• Once you've created your External Vehicle ID, click the More Actions button to the right of ClearPathGPS and select Assign External ID Values:

• Locate the Vehicle ID on the ClearPathGPS Admin Vehicle Admin page in your ClearPath GPS account.
  • The ID begins with CP followed by a six-digit number.
• For each Vehicle in Fleetio, click the box in the ClearPathGPS Value column and enter the CP value. Repeat this for EACH row.

Steps 4-7 are performed in your ClearPath GPS account

4. Setup - ClearPathGPS - Add Fleetio Vehicle Group

In your ClearPathGPS account, add a Vehicle Group called Fleetio.

• Administration > Group Admin at the bottom of the screen; in the Group ID box, type Fleetio, then click New
• Click Edit
• Name the Group Fleetio

Assign Vehicles to the Fleetio Group

• Administration > Vehicle > Admin
• Select the vehicle to add to the Fleetio Group
• Click Edit, check the Fleetio Group, then click Save

5. Setup - ClearPathGPS - Odometer

• Create a rule (Administration > Rule Admin)
  • The rule MUST be named x-api-fleetio-odo
• Edit the rule with the following settings
  • Notification Email:
  • System Rule: n/a
  • Active: Yes
  • Cron Rule: No
  • Description: Fleetio Integration - Odometer
  • Rule Selector : $InGroup("fleetio")
  • Trigger Action: Check Only "Queue"
  • Minimum Interval: 0 Seconds
  • Interval Reset: Yes
  • Predefined Actions:
  • Email Subject:
  • Email Message:

{
"apiAuth":"API KEY PROVIDED BY Fleetio",
"apiToken":"API TOKEN PROVIDED BY Fleetio",
"odo":"${odometer}"
}

• SMS Message:
• Vehicle ID: All Vehicles
• Status Code: [0xF403] Ignition_Off

6. Setup - ClearPathGPS - DTC Codes

• Create a rule (Administration > Rule Admin)
  • The rule MUST be named x-api-fleetio-dtc
• Edit the rule with the following settings
  • Notification Email:
  • System Rule: n/a
  • Active: Yes
  • Cron Rule: No
  • Description: Fleetio Integration - DTC
  • Rule Selector: $InGroup("fleetio")
  • Trigger Action: Check Only "Queue"
  • Minimum Interval: 0 Seconds
  • Interval Reset: Yes
  • Predefined Actions:
  • Email Subject:
  • Email Message:

{
"apiAuth":"API KEY PROVIDED BY Fleetio",
"apiToken":"API TOKEN PROVIDED BY Fleetio",
"faultCodes":"${faultCodes}"
}

• SMS Message:
• Vehicle ID: All Vehicles
• Status Code: [0xF911] OBDI_Fault

7. Setup - ClearPathGPS - Add Geolocation to Fueling Events

• Create a rule (Administration > Rule Admin)
  • The rule MUST be named x-api-fleetio-fuel
• Edit the rule with the following settings:
  • Notification Email:
  • System Rule: n/a
  • Active: Yes
  • Cron Rule: Daily
  • Description: Fleetio - Fueling Location Updates
  • Rule Selector: $InGroup("fleetio")
  • Trigger Action: Check Only "Queue"
  • Minimum Interval: 0 Seconds
  • Interval Reset: Yes
  • Predefined Actions:
  • Email Subject:
  • Email Message:

{
"apiAuth":"API KEY PROVIDED BY Fleetio",
"apiToken":"API TOKEN PROVIDED BY Fleetio"
}

• SMS Message:
• Vehicle ID: All Vehicles
• Status Code: All Codes

8. Setup - ClearPathGPS - Location

• Create a rule (Administration > Rule Admin)
  • The rule MUST be named x-api-fleetio-location
• Edit the rule with the following settings:
  • Notification Email:
  • System Rule: n/a
  • Active: Yes
  • Cron Rule: No
  • Description: Fleetio Integration - Location
  • Rule Selector: $InGroup("fleetio") && lat != 0 && Ion !=0
  • Trigger Action: Check Only "Queue"
  • Minimum Interval: 0 Seconds
  • Interval Reset: Yes
  • Predefined Actions:
  • Email Subject:
  • Email Message:

{
"apiAuth":"API KEY PROVIDED BY Fleetio",
"apiToken":"API TOKEN PROVIDED BY Fleetio",
"lat":"${latitude}",
"lon":"${longitude}"
}

• SMS Message:
• Vehicle ID: All Vehicles
• Status Code: All Codes