Third‑Party Integration Guide

Audience: Third‑party platform integrators / developers
Objective: Enable remote app installation to Optoma‑managed devices via OMS API.
Scope: Acquire app → Request device permission → Upload APK → Trigger install → Query installation result.

Prerequisites

·         OMS Account & API Key (OMS Portal → System Settings → API).

·         Target Device(s) already paired to your OMS tenant.

·         Package: Android APK (signed, minSDK/device‑compatible). Keep packageName, versionCode ready.

·         Base URL: Your OMS API gateway base (e.g., https://oms-apiservice.optoma.com/)

·         Auth: API key via header x-api-key: <your_key>.

·         Mocking (optional): Use x-mock: true to validate request/response without touching real devices.

High-level Flow

  1. Request permission on a device to allow package operations.
    POST /app/devices/{deviceId}/perm

  2. Upload the APK use /app/upload to obtain uploadURL and upload your APK file to this endpoint. (PUT Method)

  3. Create an install job targeting device(s) with the uploaded parameters.

  4. Poll job status. (optional)

API Details & Examples

Summary

This integration guide provides step-by-step instructions for third-party platforms to remotely install Android APK files on OMS-managed devices. The process involves five main steps:

  1. Token Request: Obtain upload credentials and verification keys from the OMS API

  2. File Upload: Upload the APK file to Azure Blob Storage using SAS authentication

  3. Permission Setup: Configure device permissions to allow app installation from unknown sources

  4. Installation Trigger: Initiate the remote installation process on the target device

  5. Status Monitoring: Poll installation status and verify successful deployment