Geotab Software Development Kit

Geotab offers more data points of connection with robust, scalable and reliable tools. The SDK features sample code and projects to get first-time developers with Geotab started.

Introduction

The Geotab SDK (Software Development Kit) is a powerful set of tools for automating tasks and working with data in MyGeotab. Within these documents you will find information on how to develop JavaScript and C# applications, build and integrate Add-Ins and use MyGeotab with third-party systems.

 

Various working examples are included in this SDK for use as a starting point with your own code e.g.:

  • Integrate an embedded MyGeotab frame in your web application (real time map, vehicle listing and more)
  • Create your own web interface to import and export Geotab data

Accessing the device’s data

The Geotab Data Feed API is a scalable, efficient and secure method to access all the device’s data.

There are three different types of data that can be requested from the API:

  • LogRecords (such as position and speed)
  • StatusData (readings of vehicle measurements e.g. oil temperature or acceleration)
  • FaultData (fault codes and measurements reported by the engine)

The data feed service sample application allows the feed to be installed as a Windows service and run continuously in the background downloading data from the server (see here).

Automating tasks

Common tasks that you perform online using MyGeotab can all be automated using the Geotab API. You can create time-saving scripts or automated processes such as:

  • When a new pick-up arrives, automate the dispatching by sending a text message to the vehicle’s Garmin through an attached GO device
  • Synchronize your customer’s location with the closest vehicle when a new work order is created

Working with Add-Ins

Geotab has developed a number of Add-In products which can be easily integrated into your MyGeotab UI. The benefits of using Add-Ins are:

  • Ready availability of Add-Ins to instantly integrate into your MyGeotab. Visit the Geotab Marketplace and the Developing Add-Ins SDK page to see the available Add-Ins
  • Versatility to create your own Add-In to customize a page or button to suit your needs

Importing, exporting and synchronizing

Geotab has a set of pre-made applications (which include full source code) for synchronizing MyGeotab data and can be used for example to:

  • Import your customer list from a CRM (Customer Relationship Management) system
  • Download your vehicle maintenance records into a maintenance system (DVIR)
  • Keep your routes up to date based the day’s deliveries
  • Synchronize your vehicle groups based on the vehicle’s role in the company
  • Track Hours of Service (HOS) for regulations compliance

You can start using these tools right now by downloading the C# examples here and the JavaScript examples here.

Integrating with MyGeotab

You can integrate an embedded version of MyGeotab into your own web application. This is perfect for providing a website to your customers with insight as to where their deliveries are and when they will arrive. You have control of which features appear on the embedded MyGeotab to create a seamless integration between your software and ours.

By using single sign-on authentication with the Geotab API, you have the ability to manage several options from your MyGeotab user accounts including:

  • Receiving an authentication token from MyGeotab for a valid username/password
  • Accepting the end user agreement on behalf of the user (this has legal implications)
  • Updating a user’s password
  • Adding and removing a user

Each of the MyGeotab pages has a URL (Uniform Resource Locator) associated with the page that allows that page to be embedded in your own application or linked to. This is a great way to leverage MyGeotab and make it part of your services. See here for more details

Integrating third-party tracking devices into MyGeotab

Third-party tracking devices can have their data added into the MyGeotab database. The Geotab API is used to provision and upload the devices data. Additionally data from these devices can be used in conjunction with data collected by Geotab GO devices. Contact Geotab support to have your third-party device added (each device type will receive a unique prefix code) and contact your reseller to handle billing.

Note: There may be differences in how devices from third-party manufacturers record the data; frequency of data collection and accuracy of the device record may vary. The rich information contained in the MyGeotab reports may not be fully available. Testing of these tracking device will be required to properly integrate the data into MyGeotab.

Please refer to Using third-party devices in MyGeotab for further details on using your own devices with MyGeotab.

Getting Started

The Geotab API (Application Program Interface) is fully available to MyGeotab customers. Geotab provides helper libraries for C# and JavaScript; however, any language or application capable of making HTTP (HyperText Transfer Protocol) requests can access its full functionality. Only valid MyGeotab user credentials are required; special API keys or tokens are not necessary. Nonetheless, we recommend that the API be accessed with a dedicated user.

Note: The examples and source code presented in the Geotab SDK (Software Development Kit) require a modern browser. We recommend using the latest versions of Chrome, Firefox, Internet Explorer or Safari.

Steps to get started

For testing purposes we recommend setting up a test database and adding test devices to it. Remember, if you decide to test against a production database, data could be accidentally modified or lost.

Plug in a Geotab GO device

Refer to the “Geotab Support Documentation” for detailed instructions on how to install a device.

Register a new database

To register, browse to https://my.geotab.com/
You can now sign in to my.geotab.com and access your database. Spend some time working through this guide and familiarize yourself with the key components of the application
Add your GO device serial number to this database so you can collect some GPS, Engine and other useful data

What’s next?

There are several other items in the SDK to help you get started:

  • Concepts — Be sure to read through this before building your application
  • API Reference — the reference documentation that explains what each API call does and documents the parameters and results for each call
  • API Runner — an easy way to “play” with the API. Click on the “Runner” link from the API Reference. It is a tool that can be used to make method calls to a MyGeotab server and see what the results look like

Note: Remember you are not in a sandbox — you are executing API commands against a real database. For example, removing a Device via the API will really delete that device from the database!

  • JavaScript or .NET Code samples. The JavaScript sample are “live” and can be run against your database hosted on my.geotab.com. The .NET examples are downloadable and can be compiled and run against your MyGeotab server.

For additional support use the SDK forums. A number of solutions have already been provided in the forums. They are monitored by Geotab staff and other users of the SDK.