Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 2.06 KB

README.md

File metadata and controls

41 lines (25 loc) · 2.06 KB
Raw

2GIS MapGL iOS API

Version

2GIS MapGL iOS API is a wrapper around MapGL API that allows you to add a 2GIS map to your iOS application.

Like the regular iOS SDK, it can be used to display the map in your interface and add various objects to it, but unlike iOS SDK, MapGL iOS API uses WebKit to render the map and is more limited in capabilities.

Getting API keys

Usage of this SDK requires an API key to connect to 2GIS servers and retrieve the geographical data. This API key is unique to the SDK and cannot be used with other 2GIS SDKs.

Additionally, if you plan to draw routes on the map, you will need a separate key - a Directions API key - to calculate and display an optimal route.

To obtain either of these API keys, fill in the form at dev.2gis.com.

Installation

MapGL iOS API is available through CocoaPods. To install it, add the following line to your Podfile:

pod 'MapGL'

Running the demo app

To run the demo app, clone this Git repository, open HelloSDK.xcworkspace and specify your API keys in Example/HelloSDK/HelloVC.swift:

enum Constants {
    static let apiKey = "YOUR_MAPGL_KEY"
    static let directionsApiKey = "YOUR_DIRECTIONS_KEY"
}

Documentation

Full documentation, including usage examples and API reference with detailed descriptions of all classes and methods, can be found at docs.2gis.com.

License

2GIS MapGL iOS API is licensed under the BSD 2-Clause "Simplified" License. See the LICENSE file for more information.