Skip to main content

Flutter SDK

Flutter SDK allows you to add an 2GIS map to your application. Using the SDK, you can display a map on the screen, get information about map objects, build routes, use the navigator, and so on.

See SDK usage examples in the Examples section.

Geodata complies with OGC standards.

You can use Flutter SDK on devices with iOS and Android operating systems.

SDK versions​

Flutter SDK packages are available in pub.dev in two versions:

  • Full is a full version that allows you to:
    • Add a map to the application and manage it: add markers and geometric shapes, control the camera movement, display layers (for example, traffic), work with map styles, etc.
    • Search for objects in the directory: organizations, buildings, places, and others.
    • Work with the navigator in the application in one of the three modes: free-drive, turn-by-turn, or simulated navigation.
    • Build optimal routes on ​​the map, including routes inside buildings.
    • Use offline data.
  • Map is a lightweight version that allows you to:
    • Add a map to the application and manage it: add markers and geometric shapes, control the camera movement, display layers (for example, traffic), work with map styles, etc.
    • Search for objects in the directory: organizations, buildings, places, and others.

Important

You cannot use Full and Map simultaneously. It causes an assembly error.

Getting API keys​

To connect to 2GIS servers, obtain geodata, and enable SDK features, you need to get an access key file:

  1. To obtain the dgissdk.key key file, fill in the form at dev.2gis.com and specify:

    • ID of the application (App ID) for which the key will be used. Make sure that the App ID meets the requirements of the target platform: iOS or Android.
    • A list of APIs that require access. The list depends on the required features and the SDK version. For more details, see the API for SDK operation section.

  2. Make sure that the key requirements are met.

After you receive the key, initialize the SDK.

API for SDK operation​

Depending on the required features, the SDK requires access keys for the maps, search, and navigation APIs. Available features depend on the SDK version: Full or Map.

When you use a key, only access to used APIs is paid based on the number of sent requests (and, in some cases, responses). You can check the statistics of API request distribution in the Platform Manager.

Map (for Full and Map)​

For more information on the available options, see the Map instruction.

Feature
APIs
Creating a map in the application
(MapWidget class)
Displaying traffic jams on the map
(TrafficSource class)		Regions API

Directory (for Full and Map)​

For more information on the available options, see the Directory instruction.

Feature
APIs
Creating a search engine
(SearchManager class)		Regions API
Getting search results
(SearchManager.search() method)		Access to certain information about objects is only available with additional key configuration for an extra fee: see the Object data structure section.
Searching for objects in the directory by ID
(SearchManager.searchById() method)
Building search suggestions
(SearchManager.suggest() method)		Suggest API

Routing (only for Full)​

For more information on the available options, see the Routing instruction.

Feature
APIs
Searching for an optimal route considering traffic jams
(TrafficRouter class)
Displaying routes on the map
(RouteEditorSource class)

For more information on the available options, see the Navigation instruction.

Feature
APIs
Starting the navigation (NavigationManager.start() method):
Searching for alternative routes
(AlternativeRouteSelector class)
Displaying road events
(RoadEventSource) class		Regions API
Calculating the device geolocation based on cell towers and nearest Wi-Fi access points
(using RadarApiSettings in Android and ru.dgis.sdk.positioning.RadarSettingsProvider)		Radar API

Key requirements​

  • You can initialize the SDK only once per application. Only one key can be used for each application. Different keys are required in the following cases:
    • If the application is available for different operating systems.
    • If the application has several alternatives for a single OS (for example, one application for the driver and another for the passenger).
    • If different SDK versions are used (Full and Map).
  • The App ID must match the app_id value in the key file.
  • Changing the key file while the application is running is not supported.

Installation​

For all platforms​

To install the Flutter SDK on iOS and Android, add one of the following dependencies to your pubspec.yaml file.

  • For the Full SDK version:

    dependencies:
        flutter:
            sdk: flutter
        flutter_localizations:
            sdk: flutter

        dgis_mobile_sdk_full:
            # When depending on this package from a real application you should use:
            #   dgis_mobile_sdk_full: ^x.y.z
            # See https://dart.dev/tools/pub/dependencies#version-constraints
            # The example app is bundled with the plugin so we use a path dependency on
            # the parent directory to use the current plugin's version.
            path: ../
    }

  • For the Map SDK version:

    dependencies:
        flutter:
            sdk: flutter

        dgis_mobile_sdk_map:
            # When depending on this package from a real application you should use:
            #   dgis_mobile_sdk_map: ^x.y.z
            # See https://dart.dev/tools/pub/dependencies#version-constraints
            # The example app is bundled with the plugin so we use a path dependency on
            # the parent directory to use the current plugin's version.
            path: ../

For full file examples, see the GitHub repository: pubspec.yaml.

Follow additional installation steps for Android.

Android​

A binary artifact in the .aar format is used when building for Android. To connect correctly, add a repository with this artifact to build.gradle of your application:

repositories {
    maven {
        url "https://artifactory.2gis.dev/sdk-maven-release"
    }
}