The MyGeotab API Adapter is a free and open source application that can be used in Windows or Linux environments. It downloads data from a MyGeotab database and writes it to a local SQL Server or PostgreSQL database.
For developers, the MyGeotab API Adapter solution serves as both an example of proper integration via data feeds and the potential foundation for those seeking to develop new integrations with the Geotab platform. It is a cross-platform .NET 9.0 (C#) application that uses the MyGeotab API data feeds to pull the most common data sets from a MyGeotab database and stream the data into tables within a SQL Server or PostgreSQL database; this could account for half the work in terms of a unidirectional integration where the data from the database is further processed for integration into an external system.
Important
As of version 3.0, the MyGeotab API Adapter solution has migrated to a new data model. The original data model and the Data Optimizer have been deprecated and will be removed from the solution after December 31, 2025.
For more information:
A good overview can be found in the MyGeotab API Adapter presentation.
Here are some videos to help get started quickly and augment the documentation below. While SQL Server is the database of choice in these videos, the processes are similar for PostgreSQL, so the videos are still relevant regardless of the database provider chosen.
▶️ How to Download the MyGeotab API Adapter (3:25)▶️ How to Set Up the MyGeotab API Adapter Database (4:20)▶️ How to Deploy and Configure the MyGeotab API Adapter Application (8:15)▶️ How to Start the MyGeotab API Adapter Application (2:15)▶️ How to Install the MyGeotab API Adapter as a Windows Service (2:29)▶️ How to Upgrade the MyGeotab API Adapter (7:11)
For more detailed information, refer to the official guide:
Want to access the above materials, but don't have a Gmail address or aren't permitted to use one? No problem - you can create a Google account without using Gmail.
Although the following documentation was developed for the original data model (and is hence deprecated), it is still somewhat relevant:
- (Deprecated) MyGeotab API Adapter presentation
- (Deprecated) MyGeotab API Adapter - Solution and Implementation Guide
- (Deprecated) MyGeotab API Adapter and Data Optimizer presentation
- (Deprecated) MyGeotab API Adapter - Data Optimizer - Solution and Implementation Guide.
The solution requires:
- MyGeotab credentials with all “View” clearances enabled on any MyGeotab database with which the MyGeotab API Adapter is to be used. It is recommended that a Service Account be set-up for this purpose and assigned to the Company Group. See the Service Account Guidelines document for more details.
- If PostgreSQL is the chosen database provider, access to a PostgreSQL 16 (or greater) server on which the adapter database is deployed.
- If the adapter and database will reside on separate servers, it may be necessary to ensure that appropriate security and networking steps are undertaken to ensure the ability of the adapter to interact with the database.
- Although not a strict requirement, it is recommended to have access to a tool such as pgAdmin to view data that the adapter writes to the database.
- If SQL Server is the chosen database provider, access to a MS SQL Server instance on which the adapter database is deployed. While developed using SQL Server 2019 Developer (version 15.0.2000.5), given that the solution uses only simple tables and views, it is likely to work on other SQL Server versions without any issues.
- If the adapter and database will reside on separate servers, it may be necessary to ensure that appropriate security and networking steps are undertaken to ensure the ability of the adapter to interact with the database.
- Although not a strict requirement, it is recommended to have access to a tool such as SQL Server Management Studio to view data that the adapter writes to the database.
To clone the repository:
> git clone https://github.com/Geotab/mygeotab-api-adapter.git mygeotab-api-adapterIn addition to the prerequisites for using the MyGeotab API Adapter, developers working with the source code will need to have the .NET 9.0 SDK or higher installed.
Although the following documentation was developed for the original data model (and is hence deprecated), it is still somewhat relevant for developers working with the MyGeotab API Adapter solution. The documentation provides an overview of the API Adapter source code and database, as well as instructions on how to add new data feeds to the adapter.
- (Deprecated) MyGeotab API Adapter - Developer Overview presentation helpful.
- (Deprecated) MyGeotab API Adapter — How to Add a Data Feed guide for step-by-step instructions.
An example process has been developed to facilitate rapid and semi-autonomous deployment of the MyGeotab API Adapter solution to the Microsoft Azure cloud platform. For more information, please refer to the MyGeotab API Adapter - Guide for Deploying to Microsoft Azure guide. Click the button below to launch the Microsoft Azure Cloud Shell which is required early in the deployment process outlined in the guide.
Utilizing the deployment process outlined in this example may result in charges incurred for utilization of Microsoft Azure resources. Geotab is not liable under any circumstances for any charges incurred as a result of following this deployment example.
Help us prioritize future efforts and better understand how the API Adapter is used! If you would like to provide any feedback about the MyGeotab API Adapter solution, please feel free to complete the 100% voluntary MyGeotab API Adapter - Usage Survey.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
