Skip to content

Commit 70ce5e8

Browse files
authored
Merge pull request #772 from Esri/swift5514
Update API Key instructions
2 parents 21fc0c0 + c2125e5 commit 70ce5e8

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

Examples/ExamplesApp/ExamplesApp.swift

+10-6
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,18 @@ struct ExamplesApp: App {
2424
}
2525

2626
init() {
27-
#warning("Require user to sign in with an ArcGIS identity or set your developer API key")
27+
#warning("You must set your API Key or request that the user signs in with an ArcGIS account")
2828
/*
29-
Use of Esri location services, including basemaps and geocoding, requires either an ArcGIS identity or an API Key. For more information see https://links.esri.com/arcgis-maps-sdk-security-auth.
30-
1) ArcGIS identity: An ArcGIS named user account that is a member of an organization in ArcGIS Online or ArcGIS Enterprise.
31-
2) API key: A permanent key that gives your application access to Esri location services. Create a new API key or access existing API keys from your ArcGIS for Developers dashboard (https://links.esri.com/arcgis-api-keys).
32-
Production deployment of applications built with ArcGIS Maps SDK requires you to license ArcGIS Maps SDK functionality. For more information see https://links.esri.com/arcgis-maps-sdk-license-and-deploy.
29+
Use of ArcGIS location services, such as basemap styles, geocoding, and routing services, requires either user authentication or API key authentication. For more information see https://developers.arcgis.com/documentation/security-and-authentication/types-of-authentication/ or https://developers.arcgis.com/swift/security-and-authentication/.
30+
1) User authentication: Allows users with an ArcGIS account to sign into an application and access secure services.
31+
2) API key authentication: A long-lived access token that gives your application access to secure services. Go to the [Create an API key](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/tutorials/create-an-api-key/) tutorial to copy the API key access token. To access all services used by this application set the location services privileges to:
32+
33+
Location services > Basemaps
34+
Location services > Geocoding
35+
36+
Production deployment of applications built with the ArcGIS Maps SDK for Swift requires that you license your app. For more information see https://developers.arcgis.com/swift/license-and-deployment/.
3337
*/
34-
// Uncomment the following line to access Esri location services using an API key.
38+
// Uncomment the following line to access ArcGIS location services using an API key.
3539
// ArcGISEnvironment.apiKey = APIKey("<#API Key#>")
3640
}
3741
}

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@ The *ArcGIS Maps SDK for Swift Toolkit* has a *Target SDK* version of *16.0*, me
4747

4848
New to Swift Package Manager? Visit [swift.org/package-manager/](https://swift.org/package-manager/).
4949

50-
## Configure API Key
50+
## Configure API Key & Licensing
5151

52-
Some of the toolkit components and examples utilize a set of ready-to-use ArcGIS Platform services, including basemaps, and therefore require an API Key to be set in `ExamplesApp.swift`. Please see the [setup guide](https://developers.arcgis.com/swift/get-started/#3-access-services-and-content-with-an-api-key/) for more information.
52+
Use of ArcGIS location services, such as basemap styles, geocoding, and routing services, requires either user authentication or API key authentication. Some of the toolkit components and examples utilize a set of these ready-to-use ArcGIS location services, including basemap styles, and therefore require an API Key to be set in `ExamplesApp.swift`. Please see [Get started](https://developers.arcgis.com/swift/get-started/#3-get-an-access-token), [Create an API Key](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/tutorials/create-an-api-key/) and [API Key Authentication](https://developers.arcgis.com/swift/security-and-authentication/#api-key-authentication) for more information.
53+
54+
Production deployment of applications built with the ArcGIS Maps SDK for Swift requires that you license your app. For more information, see [License and deployment](https://developers.arcgis.com/swift/license-and-deployment).
5355

5456
## Additional Resources
5557

0 commit comments

Comments
 (0)