Skip to content

App Device Onboarding API

Jim Lake edited this page Jul 9, 2025 · 2 revisions

Device Onboarding endpoints for API usage.

API Endpoint

All calls are made on the standard api endpoint:

https://api-prod.maxloapi.com

Check Device

Check if a device is already registered to an organization.

POST /app/1/org/:org_id/device_check

Request Authentication

app_secret_key - string - App secret key, provided in query string or body.

Request Path

org_id - number - The organization ID.

Request Body

machine_id - string - The machine ID of the device.

Responses

200 OK

device_id - number - The device ID.

device_name - string - The device name.

is_disabled - boolean - Is the device disabled.

device_session_key - string - The device session key.

404 Not Found

The device is not registered to this organization.

Register Device

Register a new device to an organization.

POST /app/1/org/:org_id/device_register

Request Authentication

app_secret_key - string - provided in query string or body.

Request Path

org_id - number - The organization ID.

Request Body

machine_id - string - The machine ID of the device.

device_name - string - The name of the device.

Responses

200 OK

device_session_key - string - The device session key.

Clone this wiki locally