---
title: "dsCONNECT Licensing and User Requirements"
canonical: "https://servicedesk.maxgeo.com/space/mxAPI/1797455873/dsCONNECT%20Licensing%20and%20User%20Requirements"
format: markdown
---
> Macro (toc)


> ℹ️ DataShed5 version 3.2 or newer is required to use the API and associated applications

# Licensing 

A valid mxAPI licence is required to connect maxgeo supported apps with the DataShed API.

The licence can be requested by either:

- Contacting the maxgeo sales team [here](https://maxgeo.com/contact/).
- Requesting a new licence through the DataShed admin portal.
- Submitting a ticket through our servicedesk portal. See link at the top of the page.

Once a valid licence has been acquired it will update overnight in the DataShed admin portal.

# User Management

Log into the DataShed Admin portal

Search for the User that requires the API Key

Select the details against the user  

Use the   option to add the mxAPI role

![image-20250814-063234.png](media://a5982f58-b737-4eea-9f22-b3b072093a80)

Navigate to Database then select the chain icon against the database  

Select the person icon to the right of the license key

![image-20250814-062621.png](media://d60a36b8-0264-4b2c-add1-b86f98265f20)

Select the  Option then select the user from the drop down list

![image-20250814-063418.png](media://64631ae4-b96e-4f4e-83cf-cf603f62b59f)


Once added the user's unique API key will be displayed

![image-20250814-063506.png](media://607ba1d1-919e-4099-b716-dd742179a317)

**NB: This key will only be displayed once**

# API key rotation

> ⚠️ NB: rotating the API will disable any prior created API Keys. API keys cannot be recovered once rotated

> ℹ️ DataShed5 v3.2 or newer is required to rotate the API in the DataShed5 app. For DataShed5 v3.1 they key can be rotated against the user in the mxAPI licensing section of the admin portal

Log into Datashed5

Under the Hello user menu select **External Connections**

![image-20250814-064000.png](media://93a0763d-d632-4124-be3f-b806627eb613)

Select the recycle button to rotate you API key

![image-20250814-064045.png](media://20bdcbca-b1ef-4653-8f4f-41b5e668087c)

This will display your new API key

![image-20250814-064133.png](media://f4818dbb-e1b3-419f-81df-c1f45030173c)

Ensure the key is copied as it will only be displayed once

# Support applications

[QGIS Plugin](https://servicedesk.maxgeo.com/space/mxAPI/1642135579/QGIS+plugin+for+mxAPI)

[dsConnect](https://servicedesk.maxgeo.com/space/mxAPI/1784152070/mxConnect+User+Guide)