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 a significant portion of the work in terms of a unidirectional integration where the data from the database is further processed for integration into an external system.
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.
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), it is likely to work on other SQL Server versions without any issues.
- Azure SQL Database is not supported due to the adapter database being partitioned. As-is, an Azure SQL Managed Instance or SQL Server on a VM are the supported options.
- 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.
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.