Integrate the SDK
This guide walks you through downloading and integrating the Magic Lane C++ SDK into your project.
Download the SDK
| Version | Download |
|---|---|
| 1.0.0 (Latest) | MAGICLANE-MAPS-SDK-CPP-WIN-VS2022-x64-7.1.26.13.91248F27DC.zip |
The Linux build is available upon request. Contact Magic Lane here to obtain the Linux package.
SDK package structure
The Maps SDK for C++ package for Windows x64 includes headers, platform-specific shared libraries, CMake integration files, and the required runtime resources:
+---bin
| +---Debug/x64/ GEM_d.dll
| +---Release/x64/ GEM.dll
|
+---include/API/ Header files (.h)
| +---Extensions/ Extended functionality headers
|
+---lib
| +---cmake/GEM/ CMake configuration files
| +---Debug/x64/ GEM_d.lib
| +---Release/x64/ GEM.lib
|
+---share/Data/ Runtime resources needed for initial startup of the SDK
Build and run
To get started quickly, clone or download the official examples repository:
git clone https://github.com/github/magiclane-maps-sdk-examples-for-cpp.git
The repository contains a comprehensive set of example projects covering maps, navigation, search, routing, VRP, and more. Follow the build instructions in the repository's README.md to configure prerequisites, set up your environment, and build the examples.
Configure your API key
An API key is required to unlock the full functionality of the SDK. Follow the Get Started guide to generate your key.
Without a valid API key, a watermark will be displayed and all online services - including mapping, searching, and routing - will be throttled after a few minutes.