Migrate to ArcGIS location services

Follow these steps to migrate your existing app to use ArcGIS location services.

This information is intended for developers who have an existing app and would like to update it to use ArcGIS location services. Use the current version to ensure that you have access to the latest capabilities.

Authentication

To use any of the ArcGIS location services, your app must provide authentication with an appropriate access token. Access tokens define the privileges available to your application. There are three types of authentication that can be used to access location services:

• API key authentication: This type of authentication uses a long-lived access token to authenticate requests to ArcGIS location services. For more information see the Introduction to API key authentication. Go to the Create an API key tutorial to obtain a new API Key access token using your ArcGIS Location Platform account or ArcGIS Online account account. This is the recommended type of authentication for developers new to ArcGIS, or to development in general.
• User authentication: This generates a short-lived token via OAuth credentials, authorizing your application to access ArcGIS location services on behalf of a user logged in with an ArcGIS Location Platform or ArcGIS Online account.
• App authentication: This generates a short-lived token via OAuth credentials, authorizing your application to access ArcGIS location services on your behalf.

Learn more about getting and using an access token in Security and authentication and the Display a map tutorial.

Global API key

When your app starts, you can set the api key on your ArcGISRuntimeEnvironment to an API key access token. This authorizes access to all ArcGIS location services used by your app.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
    const QString accessToken = QStringLiteral("YOUR_ACCESS_TOKEN");

    if (accessToken.isEmpty())
    {
        qWarning() << "Use of ArcGIS location services, such as the basemap styles service, requires "
                        "you to implement user authentication or set the API Key property.";
    }
    else
    {

        ArcGISRuntimeEnvironment::setApiKey(accessToken);

    }

When your app starts, you can set the api key on your ArcGISRuntimeEnvironment to an API key access token. This authorizes access to all ArcGIS location services used by your app.

Basemaps

Review the basemap styles service and the variety of basemaps available. Create a new basemap using one of the enumeration values from BasemapStyle and use it to create your Map.

You can set an API Key access token directly on the basemap or default to a global access token, if one is set on the ArcGISRuntimeEnvironment. The API Key must have the privilege Basemap styles service enabled.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
    // Create a new 'topographic' basemap.
    Basemap* basemap = new Basemap(BasemapStyle::ArcGISTopographic, this);

    // Optionally, set a specific API key for the basemap.
    // (Not required if a global API key is set)

    basemap->setApiKey("YOUR_ACCESS_TOKEN");

    // Create a map that uses the basemap.
    Map* map = new Map(basemap, this);

Geocoding

Access to the geocoding service is available using an API Key access token, either globally for the app, or by setting it explicitly on your LocatorTask. If you are using an API key access token it must have been generated with the Geocoding privilege.

Routes and directions

Access to routing and directions APIs is unchanged with the new ArcGIS location services introduced with ArcGIS Location Platform. Authentication is required to access these services, using API key authentication or user authentication. If you are using an API key access token must have been generated with the Routing privilege.

See the Find routes and directions topic for more information.

Other services

See all the Location services available.