Pay attention to using a valid Authentication token. The token can be passed in the header or as a query parameter.
For header use: Authorization: Bearer <token>
For parameter use: ?token=<token>
Please ensure to set a new device key. Generate your token using your key using the tool at the ProMGR website.
For more information, see the Quick Start Guide.
Set all LEDs to a specific color
Authorizations:
query Parameters
| lrgb required | string Enum: "255,0,0,0" "255,255,0,0" "255,0,255,0" "255,0,0,255" "0xFFFF0000" "0xFF00FF00" "0xFF0000FF" Color to set the LEDs to (e.g., Brightness, red, green, blue) |
header Parameters
| Access-Control-Allow-Origin required | string Example: * CORS headers |
Responses
Response samples
- 401
{- "status": "Error",
- "statusText": "Auth token not provided or incorrect"
}Individual Led Control
Set individual leds to specific colors. The lrgb parameter must contain the exact amount of LEDs present on the device, separated by semicolons. Each LED color is defined by four comma-separated values representing brightness, red, green, and blue (e.g., "255,0,0,0;255,0,255,0;255,0,0,255" for a device with three LEDs).
Authorizations:
query Parameters
| lrgb required | string Example: lrgb=255,0,0,0;...N...;255,0,0,255 LRGB color values for each of the LEDS (Must be exact amount of LEDs) |
Responses
Response samples
- 200
- 401
{- "status": "OK",
- "statusText": "Set LED color"
}Response samples
- 200
- 401
{- "status": "OK",
- "deviceKey": "string",
- "deviceManufacturer": "string",
- "deviceModel": "string",
- "deviceDisplay": "string",
- "devicePlatform": "string",
- "ledControllerType": "string",
- "androidSdk": "string",
- "androidVersion": "string",
- "serialNumber": "string",
- "ip4Address": "string",
- "screenBrightnessInternal": 0,
- "screenBrightness": 0,
- "showSystemBars": true,
- "touchScreenEnabled": true,
- "deviceInteractive": true,
- "apiAppPackageName": "string",
- "apiAppVersion": "string",
- "apiAppVersionCode": "string",
- "apiAppSystemSigned": true,
- "apiAppSystemFlagged": true,
- "apiAppSystemUser": true,
- "apiRemoteCallEnabled": true
}Set a unique device key
Set a unique device key for the device (200 Response not guaranteed to be as given below)
Authorizations:
query Parameters
| deviceKey required | string Example: deviceKey=unique-device-key-12345 Unique device key to set |
Responses
Response samples
- 200
- 401
{- "status": "OK",
- "statusText": "Device key set successfully"
}Download a file to the device
Authorizations:
query Parameters
| url required | string <uri> URL of the file to download |
| dir required | string Example: dir=/sdcard/Download/ Directory to save the downloaded file. Please enure to encode the path |
Responses
Response samples
- 200
- 401
{- "status": "OK",
- "statusText": "Starting download...",
- "downloadToken": "1234567890abcdef"
}Get information about a download
Authorizations:
query Parameters
| downloadToken required | string Example: downloadToken=1234567890abcdef Token for the download |
Responses
Response samples
- 200
- 401
{- "status": "OK",
- "downloadStatus": "IN_PROGRESS",
- "downloadStatustext": "Download in progress",
- "downloadDir": "/sdcard/Download/",
- "downloadFileSize": 12345678,
- "downloadFilePath": "/sdcard/Download/file.zip"
}Install a file on the device
Install a file on the device, typically an APK file
Authorizations:
query Parameters
| file required | string Example: file=/sdcard/Download/file.apk Path of the file to install |
| runAfterInstall | boolean Default: false Flag to run the app after installation |
Responses
Response samples
- 200
- 401
{- "status": "OK",
- "statusText": "Installation started",
- "installFile": "/sdcard/Download/file.apk",
- "installToken": "abcdef1234567890"
}Get information about an installation
Get information about an installation in progress
Authorizations:
query Parameters
| installToken required | string Example: installToken=abcdef1234567890 Token for the installation |
Responses
Response samples
- 200
- 401
{- "status": "OK",
- "installStatus": "IN_PROGRESS",
- "installFile": "/sdcard/Download/file.apk",
- "packageName": "com.example.app"
}