Overview

Just Add Power’s justOS HTTP API (justAPI) is a RESTful interface that allows external systems, scripts, and control platforms to monitor and interact with supported Devices.

The API provides access to real-time device status, configuration settings, and command execution for both Encoders and Decoders. It is intended for automation, third-party integrations, and advanced system diagnostics.

Supported Platforms:

• MaxColor Series (MC)
• Ultra Series (UL)
• Omega Series (OM)

Minimum Firmware Requirement:

• Omega & Ultra Series: B1.1.0 or later
• MaxColor Series: MAX v3.5.2 or later

justOS HTTP API Documentation

Accessing the API

Each Device hosts its own API. The Device’s IP address is used as the base URL (HOST).

Base URL Format:

http://HOST/cgi-bin/api/URI

HOST = Device IP address
URI = API endpoint path

Example Request:

GET http://192.168.100.130/cgi-bin/api/details/device/firmware/version

Example Response:

{"data":"B3.2.0"}

All API responses are returned in JSON format using the following structure:

• "data" — Present on successful requests
• "error" — Present on failed requests

API Structure

The justAPI is organized into three primary categories:

• Command — Immediate device actions
• Details — Read-only status information
• Settings — Persistent configuration values

Command

Purpose: Executes actions that have an immediate effect on live device behavior.

Method: POST

Headers:

• Accept: application/json or text/plain
• Return: application/json

Key Characteristics:

• Changes take effect immediately
• Requests must target specific endpoint URIs
• Bulk JSON commands are not supported

Details

Purpose: Retrieves real-time, read-only status information from the Device.

Method: GET

Return Type: application/json

Key Characteristics:

• Provides live system status
• Supports both:
  • Specific endpoint queries (faster)
  • Bulk queries using parent URIs (slower but more comprehensive)

Settings

Purpose: Configures device behavior that persists after reboot.

Methods: GET, POST

Headers:

• Accept: application/json or text/plain
• Return: application/json

Key Characteristics:

• Supports bulk GET and POST operations by targeting parent URIs
• Bulk operations will take longer than individual endpoint requests
• Changes require a reboot to take effect

Special Values

The justAPI uses false and null as special indicators depending on the request type.

Details Responses

• false — Resource is valid but currently unavailable or disabled
• null — Resource is not supported on this hardware

Settings Responses

GET:

• false — Resource is valid but disabled or not set
• null — Resource is not supported on this hardware

POST:

• false — Valid only for resources that accept boolean values
• null — Clears any current setting applied to a valid resource

Command Responses

• false — Valid only for commands that accept boolean values
• null — Invalid for all command requests