ESRI provider key

How to add an ESRI provider key to MapHub

This guide shows how to create a new ArcGIS Location Platform account and generate an ESRI API key for MapHub.

Note: ESRI API keys can only be valid for a maximum of 1 year. They will expire and need to be renewed annually to continue using ESRI basemaps.

  1. Go to the ArcGIS Location Platform.
  2. Click Sign up for free.
  3. Enter your first name, last name, and email address, then click Continue.
  4. On the Confirm account details page, choose a username, password, portal URL, portal display name, security question, and answer. (Note: These details are for your ArcGIS account and do not need to match your MapHub account.)
  5. Accept the ArcGIS Location Platform agreement and Esri privacy policy, then click Next.
  6. Check your email for an activation link. Click it to verify your account, then sign in.
  7. On the Finish setting up your account page, answer the required onboarding questions and click Finish account setup.
  8. On the ArcGIS Location Platform dashboard, locate the Developer credentials section and click Create developer credentials.
  9. Select API key credentials, then click Next.
  10. On Where will you use these credentials?, select Public application, then click Next.
  11. On Item access, select Grant access to specific items, then click Next.
  12. On Privileges, enable Basemaps under the Location services section, then click Next.
  13. On Settings, select an Expiration date. ArcGIS API keys can be valid for a maximum of one year from today.
  14. Leave the Referrer URLs empty, then click Next.
  15. On Item details, enter a title (e.g., maphub-api-key), then click Next.
  16. Review the summary, make sure Generate the API key now is selected, and click Next.
  17. Copy the generated API key. Important: Copy the API key value immediately. The dialog is only shown once, so be sure to paste it somewhere safe before closing it. Note: Sometimes the wizard finishes without creating or showing the API key. If this happens, delete the developer credentials item you just created and start the wizard again.
  18. Go to your MapHub account's Map provider keys page: link
  19. Paste the copied key into the ESRI API key field.
  20. Click Save.
  21. Congratulations, you can now use ESRI basemaps on MapHub!

If you do not see the dashboard wizard

Sometimes ArcGIS opens your account on the Content page instead of showing the dashboard wizard. The video below shows how to access the credential creation flow from there.

  1. Open your ArcGIS Content page from the top menu.
  2. Click the New item button.
  3. Select Developer credentials.
  4. Continue from step 9 in the guide above.

Renewing an expired API key

When your ESRI API key expires (or is about to expire), you will need to regenerate it and update it in MapHub to keep your basemaps working.

  1. Go to your ArcGIS Location Platform Content page.
  2. Click on your API key item (e.g., maphub-api-key).
  3. Scroll down to the Credentials section.
  4. Click the Regenerate API key button.
  5. In the confirmation dialog, click Confirm expiration date.
  6. Select a new expiration date (up to a maximum of one year from today).
  7. Click Yes, regenerate API key.
  8. Copy the newly generated API key.
  9. Go to your MapHub account's Map provider keys page: link
  10. Replace the old key by pasting the new one into the ESRI API key field and click Save.