topic Re: Map without API key in ArcGIS JavaScript Maps SDK Questions

Map without API key

ScottAndersonGQ — Mon, 11 Oct 2021 20:07:32 GMT

I wrote some code that creates a map and allows users to click on the map. The click takes the lat,lng (of click) and queries a government's GIS database and returns the parcel number. They can also use the default search widget and search by address, which ultimately does the same thing.

I also added a polygon layer that outlines parcels and another polygon layer that outlines houses.

I am NOT USING AN API KEY. I am NOT using esriConfig.

The code works and seems fairly easy to disseminate. I just add:

The Questions is: Do I still need an API key? If so, does the search widget use a Geocoding credit? Does the adding a layer or loading the basemap use a Basemap credit?
If not, why not? (But also not complaining)

Extra Info:
To Query I use -> {featurelayerlink}/query?geometry={lat} {lng}&...etc
To Add a Layer I use -> map.add(new FeatureLayer({ url: featureLayerURL, ...etc }))
To Make the map -> map = new Map({ basemap: "streets", });

Re: Map without API key

BjornSvensson — Mon, 18 Oct 2021 22:03:56 GMT

Hi @ScottAndersonGQ - as for your question about "Do I need an API key?":

That depends on your account. If you are using an ArcGIS Developer account, then yes, you need an API key. If you are using an ArcGIS Online account, then no, API key is not required.
https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/accounts/#arcgis-online-accounts
As shown on that page, if you're using an ArcGIS Online account, then "Basemap layers" and "Geocoding (not stored)" does not consume credits.

Re: Map without API key

LeandroAlmeida — Tue, 30 Nov 2021 20:37:21 GMT

I also came across the same situation while configuring my application to use a token-based authentication from ArcGIS Enterprise.

If you check this codepen you can see what we mean.

There is no code to input an API key nor a token and yet the map loads without a problem.

All the basemaps from this documentation section works without authentication.

"For use without an API key
Use of these basemaps requires a valid ArcGIS Online organizational subscription or an ArcGIS Enterprise license."

Is it correct to assume these base maps don't need authentication of any kind to be loaded? If so, will it continue to be accessible in the future in the same manner?

Re: Map without API key

BjornSvensson — Wed, 01 Dec 2021 05:31:29 GMT

If you have an ArcGIS Enterprise license , you can legally use the basemaps listed under "For use without an API key" - and your application does not need to specify an API key.

@LeandroAlmeida - does this help clarify?

Re: Map without API key

LeandroAlmeida — Wed, 01 Dec 2021 19:08:44 GMT

Thanks for the reply, Bjorn

I understand API Keys are just for ArcGIS Online and Enterprise should use token or OAuth authentication, but what I don't understand is what tells ArcGIS that I really have a license in the first place if I can go to codepen or any other site and just input a code with no reference to my enterprise account whatsoever?

Is it just for demonstration/testing purposes?
If so, why the maps accessible with the API key is not open for testing as well?
Does this approach without a key or token have any limits to how much the application can consume?

I'm asking all these questions because if we can just ship out a code without any API/token reference that's the way we will take it since we won't have to deal with another endpoint to handle authentication (we are using client_credentials tokens).

I just want to be certain that this approach will keep working in the future, in order to keep our site running without problems.

Just to give you a context, the website in question is only using the base map, all the other layers are being generated on the client side.

Re: Map without API key

BjornSvensson — Thu, 02 Dec 2021 20:09:34 GMT

Hi @LeandroAlmeida
Technically there is nothing that tells ArcGIS that you indeed have an Enterprise license. It's a "paper" license. The terms are described in details in the E300 MLA - https://www.esri.com/en-us/legal/terms/product-specific-scope-of-use.
There's no special limits for using this keyless/tokenless approach - assuming you have the license.

We don't currently have any plans to change that as far as I know.

https://developers.arcgis.com/javascript/latest/licensing/

Re: Map without API key

NarasimhaNallamsetty — Tue, 03 Jan 2023 09:19:59 GMT

Hi @BjornSvensson , please help me with iOS code to setup map without API key for ArcGIS enterprise account. Please share sample code or links for iOS and Android. thank you in advance.

Re: Map without API key

BjornSvensson — Thu, 05 Jan 2023 22:53:44 GMT

Hi @NarasimhaNallamsetty , for questions related to iOS/Android, I would recommend asking in their related communities, see https://community.esri.com/t5/arcgis-maps-sdks-for-native-apps/ct-p/arcgis-runtime-sdks

Re: Map without API key

Flayner — Mon, 08 Jan 2024 14:14:38 GMT

Hi @BjornSvensson, I'm in the same situation as @ScottAndersonGQ and @LeandroAlmeida, however, in the link provided in the image below there is no longer the option you mentioned. I didn't find the basemaps that can be used without using an API Key.

We have the ArcGIS enterprise license, and I would like to know if there is still an option to use basemaps without using the API Key.

Re: Map without API key

BjornSvensson — Wed, 17 Jan 2024 19:13:53 GMT

@Flayner - the basemap documentation is available at https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap .
In your case, you're looking for option 2, "From a basemap id" - see https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap-id

Re: Map without API key

MichaelKatz-NOAAAffiliate — Mon, 26 Feb 2024 06:56:48 GMT

@BjornSvensson I am part of an organization (NOAA) that has an Esri enterprise license. I want to use vector basemaps without an API key as those above are doing, but I need to use them through OpenLayers, not through the Ersi JavaScript API. I see examples like https://codepen.io/lndr27/pen/yLzyYNw (reference above) that use the Esri API and just have to specify basemap: "satellite" as part of making their map object. But in the OpenLayers examples such as https://developers.arcgis.com/openlayers/layers/add-a-vector-tile-layer/, an API key is used, and trying to leave it off the URL results in a 401 permissions error for me. Can you point me to an example of using a styled vector basemap under OpenLayers without an API key?

I was able to get as far as the code below. It adds the layer, but the layer is just in a blue outline, which I take to be the layer without any styling applied. Is there a way for me to apply styles to this layer (without an API key)? Or is this the wrong approach?

Re: Map without API key

Gowin — Tue, 27 Feb 2024 19:14:47 GMT

Hi there,

You have the correct URL to access the enhanced endpoint of the basemap styles service, which does allow you to access basemaps without an API key.

The standard practice for styling ArcGIS vector basemaps in OpenLayers is to request the layer info as Mapbox style JSON and use ol-mapbox-style to load the basemap. The OpenLayers "Display a map" tutorial is a good example of this pattern. However, the enhanced endpoint that you are using does not support mapbox style JSON, which is a requirement to style basemaps in OpenLayers.

Unfortunately, Mapbox style JSON is only supported by the new basemap styles endpoint (docs here), which does require an API key / other access token. I'm not sure if there is a workaround for your specific use case. I will look into this more.

My suggestion for now would be to implement an Image tile basemap instead (doesn't require authentication). Alternatively, if API keys are the limiting factor, I would recommend that you implement an alternative method of authentication such as user authentication or app credential authentication.

Hope this helps.

Re: Map without API key

BjornSvensson — Sat, 06 Apr 2024 00:18:07 GMT

@MichaelKatz-NOAAAffiliate , hopefully you have already gotten an answer to your question about OpenLayers. If not, it's better to ask in the Open Source Mapping Libraries community -- https://community.esri.com/t5/open-source-mapping-libraries/ct-p/open-source-mapping-libraries