Creating and Using API Credentials

Some common use cases for SOTI MobiControl APIs:

• Provisioning devices during employee on-boarding/off-boarding.
• Migrating device configurations triggered by external applications.
• Exporting SOTI MobiControl data for analytical purposes.
• Integrating with billing systems for pay-per-use device deployments.
• Integrating SOTI MobiControl administrative actions within other administrative console applications.

Use Restful APIs to integrate SOTI MobiControl into other existing enterprise mobility workflows or partner applications. You can find specific documentation about the required integrators and where to test them by navigating to /MobiControl/api in your web console.

Note: Supported in SOTI MobiControl 13.0 and later.

Syntax: https://server.domain.tld/MobiControl/api

Example: Change

https://testserver.mobicontrolcloud.com/MobiControl/WebConsole/devices

to
https://testserver.mobicontrolcloud.com/MobiControl/api

Note: For SOTI MobiControl v2024.0 and later. API Client credentials can also be created from the SOTI MobiControl web console (see the API Client Credentials Creation MC v2024.0 and Later section below).

Creating API Credentials

1. Log into the SOTI MobiControl web console and, in the web browser's address bar, replace everything after MobiControl/ with api to open a new web page.

For example, https://testserver.mobicontrolcloud.com/MobiControl/api/

Warning: API calls sent from this page are executed against your SOTI MobiControl environment. Proceed with caution when doing this in a production environment.

2. Verify you have a local administrator account on the console that can execute the APIs. Do this by navigating to Users and Permissions > Local Users. If such an account does not exist, create a new local admin user.

Note: In this example, the user is: APICredUser

3. Open a CMD window in Administrator mode on the SOTI MobiControl management server and create the API credentials using the following commands:  

cd c:\program files\soti\mobicontrol\

.\MCAdmin.exe APIClientAdd -n:APICredUser

4. Select Copy to save the credentials to a safe text file.

API Client Credentials Creation MC v2024.0 and Later

1. Log in to the SOTI MobiControl console as administrator and select Menu > Global Settings.

2. Go to Services > API Client and select the + icon.

Note: Any client credentials created with the other method (using CMD on the Server), will be listed in the API Client window.

3. Enter a name for the API Client and select Generate.

4. Copy the ID and Secret to a safe text file and select OK.

Testing Created Credentials

Note: Client API Credentials can be used for multiple users as long as they have administrator access. However best practice would be to create one for each user.

1. Log in to the SOTI MobiControl API console using the newly created Administrator account. Navigate to the API page and select Authorize. 

2. Add the required account details and API credentials, then select Authorize to log in.

3. Once logged in, choose an API to test by selecting Try it Out.

4. Edit the JSON string and then select execute to test the API.

5. Confirm successful execution by reviewing received responses.