Yandex MapKit and NaviKit Demo Apps

Yandex MapKit and NaviKit are cross-platform libraries that let you use the capabilities of Yandex Maps in mobile applications for iOS and Android. Learn more about the MapKit and NaviKit SDKs on the documentation page.

For a quick start development with the MapKit and NaviKit SDKs visit the following pages:

• Getting started with MapKit SDK
• Getting started with NaviKit SDK

The current repository contains sample code for how to use the MapKit and NaviKit SDKs for iOS applications.

Project structures

There are three iOS projects in the repository:

1. MapkitSamples: Contains several iOS applications with sample code in Swift, all of which are demonstrated in the MapKit SDK Tutorials documentation.

   • MapWithPlacemark: A simple MapKit SDK application with Getting started with MapKit for iOS information.

   • MapObjects: Using the Map Objects API to add objects to the map.

   • MapInteraction: Examples from the Map Interaction tutorial.

   • MapSearch: Examples of how to use the Search and Geosuggest functionality.

   • MapRouting: About the Routes and Routing API.

2. MapKitDemo: A demo application that contains the basic functionality of the lite and full MapKit SDK versions. It is not supported with Tutorials documentation, unlike the MapkitSamples project.

3. NaviKitDemo: A demo application showcasing the basic navigation features you can implement with NaviKit SDK.

Build locally

1. Clone the repository:

   git clone https://github.com/yandex/mapkit-ios-demo.git
   

2. Execute the following command in your project's directory to install dependencies:

   pod install
   

3. MapKit SDK demo application and samples require API key. You can get a free MapKit API key in the Get the MapKit API Key documentation. The instruction on how to obtain NaviKit API key is described in the documentation.

4. Depending on the project you want to build, follow the steps in the following sections.

MapkitSamples

1. Open the project's build settings. Add the following user-defined setting with your API key value in place of the YOUR_API_KEY placeholder:

   MAPKIT_API_KEY = "YOUR_API_KEY";
   

2. Choose the desired target in Xcode, build and run.

MapKitDemo

1. Open the AppDelegate.swift and edit the MAPKIT_API_KEY constant declaration, setting its value with your API key in place of the YOUR_API_KEY placeholder:

   let MAPKIT_API_KEY = "YOUR_API_KEY"
   

   You can as well store this API key in your project's build settings and Info.plist file.

2. Build and run the MapKitDemo target in Xcode.

NaviKitDemo

1. Open the project's build settings and edit the MAPKIT_API_KEY parameter, setting its value with your API key in place of the YOUR_MAPKIT_API_KEY placeholder:

   MAPKIT_API_KEY = YOUR_MAPKIT_API_KEY;

   You can as well store this API key in your Info.plist file.

2. Build and run the NaviKitDemo target in Xcode.

Support

If you have problems or suggestions while using MapKit or NaviKit SDK, visit the contact page.

Sample overview

MapWithPlacemark Demonstrates how to create a MapKit map, move it, and display custom tappable placemarks.	MapObjects How to display different objects on the map, including: images, geometries, and clusterized collections.

MapInteraction About interacting with the MapKit map using camera movements, tap actions, focus rect and focus point, and interactions with POIs.	MapSearch Shows how to use Search and Geosuggest functionality in the full MapKit SDK.

MapRouting Building routes using requested map points.