Table of Contents
Advertisement
7. Lightware REST API Reference
6.1. Overview
The Lightware REST API is designed to provide a platform-free interface, where the MMX2 series switchers
can be controlled by HTTP requests. REST API is a software architectural style based on HTTP protocol, so
it can be used via web browser, Node.js, terminal programs.
The MMX2 series device provides a REST API server where most of the LW3 commands are available (for
more details, see the
Lightware REST API vs. LW3 Protocol
Lightware devices can be controlled with LW3 protocol commands (for more details, see the
Programmers'
Reference), LW3 protocol consist of read-only, read-write properties and methods, which
operate the same way as REST API GET/POST methods. This is not a new protocol, the LW3 tree structure
became available via HTTP(s).
6.2. Instructions for the Terminal Application Usage
6.2.1. Web Browser Plugins
REST API interface can be easily accessed via a web browser's plugin, see the example below:
RESTClient plugin for Mozilla Firefox
section).
LW3
Applied firmware package: v1.3.3b3 | LDC software: v2.5.14b5
MMX2 series – User's Manual
6.2.2. Terminal Application
The REST API requests can be applied to the switcher using a terminal application. You need to install one
of them to your control device, for example, Putty, CLI or Curl.
Curl
Curl is a command line tool that can also connect to the MMX2 REST SERVER and display communication
in a terminal window. It supports data transferring with HTTP and HTTPS standards and handles the basic
authentication (username and password) in Windows
are also accepted, so a script can be stored in a .txt file for future reference.
Check if the Curl package is installed on your system. Type into your console: curl. When the answer is
'curl: try 'curl --help' for more information', curl is installed.
Some web browser plugins (e.g. REST Client) display the curl version of the sent request.
Once the terminal window is opened, you can enter the commands. Some typical examples are listed in the
following section.
REST API communication in a command line window
#terminal
and Linux operating systems. Multi-line commands
®
45
Advertisement
Table of Contents
Troubleshooting
