Implement API key authentication

Your app needs an access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more to use location servicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more.

1. Go to the Create an API key tutorial to obtain a new API key access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more.

   • Ensure that the necessary privilegesPrivileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more are enabled for the functionality your app requires. If you need to use basemaps, for example, enable access to the Basemap styles service: Location services > Basemaps > Basemap styles service.

   • Copy the access token as it will be used in the next step.

2. In Android Studio, click the Android view in your app project. Then open app -> kotlin+java -> com.example.app -> MainActivity.kt.

   • In MainActivity.kt, add ArcGISEnvironment and ApiKey to your imports.
   MainActivity.kt

   Use dark colors for code blocks

   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
   
   package com.example.app
   
   import android.os.Bundle
   import androidx.activity.ComponentActivity
   import androidx.activity.compose.setContent
   import androidx.activity.enableEdgeToEdge
   
   import com.arcgismaps.ApiKey
   import com.arcgismaps.ArcGISEnvironment
   
   import com.example.app.screens.MainScreen
   import com.example.app.ui.theme.TutorialTheme
   
   • Set the ArcGISEnvironment.apiKey property by calling ApiKey.create() and passing your API Key access token.
   MainActivity.kt

   Expand

   Use dark colors for code blocks

   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
   class MainActivity : ComponentActivity() {
   
       override fun onCreate(savedInstanceState: Bundle?) {
           super.onCreate(savedInstanceState)
   
           ArcGISEnvironment.apiKey = ApiKey.create("YOUR_ACCESS_TOKEN")
   
           enableEdgeToEdge()
   
           setContent {
               TutorialTheme {
                   MainScreen()
               }
           }
       }
   }

For more information, see API key authentication.

Best Practice: The access token is stored directly in the code as a convenience for this tutorial. Do not store credentials directly in source code in a production environment.