Get started

Get started with ArcGIS Maps SDK for Java:

  1. Review system requirements
  2. Install and set up
  3. Get an API key (to access services)
  4. Start the Display a map tutorial

1. System requirements

Ensure your development environment meets the system requirements.

For an overview of this release, including enhancements, deprecations, and known issues, see the Release notes.

2. Install and set up

An app built with ArcGIS Maps SDK for Java requires the following dependencies:

  • The arcgis-java jar
  • jniLibs, resources, and required libraries
  • OpenJFX 17 modules

There are three ways to get set up with the API:

  • Gradle
  • Maven
  • Downloaded .zip file

3. Access services and content with an API key

API keys are permanent tokens that grant your application access to ready-to-use services and, with an ArcGIS Developer account, private content hosted in ArcGIS (currently in beta). Your apps will always require an access token, such as an API key or OAuth 2.0 token, in order to access these resources. Refer to authentication methods in the developer guide for details.

To set an API key in your application, find and copy an API key from your developer dashboard and replace the string YOUR_API_KEY / ACCESS_TOKEN in your code with the API key copied from your dashboard. This key is scoped to provide access to all of the services and resources shown in the tutorials.

  1. Log in to your developer dashboard.
  2. Select and copy your default API key, or generate a new one.
  3. In your code, replace the string YOUR_API_KEY / ACCESS_TOKEN with the API key from your dashboard.

4. Tutorials

Follow step-by-step instructions to build apps that incorporate key features of ArcGIS Maps SDK for Java.

Display a map

Add a point, line, and polygon

Add a feature layer

Display a web map

Browse all tutorials

Deploy your app

A license isn't required to develop apps with this SDK; you don't need to authorize your development machine or devices. As a member of the ArcGIS Developer Program, you have a free ArcGIS Developer Account (Essentials Plan). With this plan, you can download and install any ArcGIS SDK and immediately have access to all the functionality of the APIs for development purposes. You can become a member of the developer program for free.

You need an ArcGIS Developer Subscription to deploy an app to your users. The Essentials plan is free.

Learn more about licensing and deployment and get your license string at License and deployment.

Next steps

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.