Migrate to ArcGIS location services

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

This information is intended for developers who have an existing app built with one of the ArcGIS Runtime APIs and would like to update it to use ArcGIS location services. To use the services, your app must use ArcGIS Runtime version 100.10 or later. Use the current version of ArcGIS Runtime to ensure that you have access to the latest capabilities.

If your app was built with ArcGIS Runtime version 10.x, refer to the Migrate to 100.x from 10.2.x topic for help migrating to 100.x.

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. 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 API Key access token on the ArcGISRuntimeEnvironment . This will allow your app to access location services according to the privileges of the access token.

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
  @Override
  public void start(Stage stage) {
    // set the title and size of the stage and show it
    stage.setTitle("Display a map tutorial");
    stage.setWidth(800);
    stage.setHeight(700);
    stage.show();

    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
    StackPane stackPane = new StackPane();
    Scene scene = new Scene(stackPane);
    stage.setScene(scene);

    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

If you want to monitor the usage of location services by different parts of your application, you can override the access token set on the ArcGISRuntimeEnvironment by providing a different access token for any classes that implement ApiKeyResource .

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 ArcGISMap .

You can set an access token directly on the basemap or default to a global access token, if one is set on the ArcGISRuntimeEnvironment .

1
2
3
4
5
6
7
8
9
10
11

  // Create a new 'topographic' basemap.
  Basemap basemap = new Basemap(BasemapStyle.ARCGIS_TOPOGRAPHIC);

  // Optionally, set a specific access token directly for the basemap.
  // (Not required if an access token has been set on the ArcGISRuntimeEnvironment).

  basemap.ApiKey = "YOUR_ACCESS_TOKEN";

  // Create a new map that uses the basemap.
  ArcGISMap map = new ArcGISMap(basemap);

Geocoding

Use the geocoding service and provide an API key, either globally for the app, or by setting it explicitly on your LocatorTask .

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 any Type of authentication.

See the Find routes and directions topic for more information.

Other services

See all the Location services available.