System API
Shure System Application Programing Inter-
face
Installation guide for Shure System API
Version: 2.1 (2024-A)
Shure Incorporated
Table of Contents
Installation and Setup 3
System API Shure System Application Programing In
terface 3 Shure System API Resources 4
What is System API? 3 Supported Devices 4
System Requirements 3
2/5
Shure Incorporated
System API
Shure System Application Programing Interface
What is System API?
Shure System API is an application programming interface for controlling and monitoring Shure devices, whether on premises
or remotely. System API enables 3rd party device manufacturers and software developers to integrate comprehensive and cus
tomizable system management intuitively.
System API is an installed appliation server that lives on a computer connected on one or more networks of Shure devices. You
can remotely connect to System API using an HTTP client. All responses are returned in JSON format.
Features:
• RESTful API: Highly scalable and interactive with other control and monitoring systems that are already in use across en
terprise applications.
• Comprehensive monitoring and control capabilities: Adjust audio gain and mute, monitor battery levels, update firmware,
and perform routine device and network maintenance.
• Streamlined setup and scalability: Ease & speed of install enables savings on deployment efforts, time on-premises, and
resources.
• Remote management: Access, control, and monitor your Shure devices from remote computers, tablets, or smartphones
via HTTPS
• Real time updates: Monitor changes in your devices using WebSockets
• Install on a physical or a virtual machine for maximum flexibility and easier management.
• Enhanced network security: via HTTPS, 802.1x, and SRP that ensure robust network security protocols across an enter
prise.
• Easy to learn: For those with minimal to no API experience via Stoplight.io and Stack overflow.
System Requirements
Application architecture: 64 bit
Supported operating systems:
• Windows 10 and 11
• Windows Server 2016, 2019, and 2022
Processor: Dual-core (or greater) 64-bit processor
System memory: 2 GB minimum; 8 GB recommended
User access: Administrator privileges
3/5
Shure Incorporated
Installation and Setup
Download System API from the Shure System API product page. Follow the prompts to install and launch the application.
Things to note:
• Web server port: Designate an open port for Shure System API. This is the port you'll use to communicate with the API
from your integration.
• TLS Certificate
◦ If you only intend to access System API from the machine it is installed on, you don't need to provide your own certifi
cate. Accept the default and follow the instructions in Stoplight to trust the self-signed certificate.
◦ If you intend to access APIs from remote machines, follow the instructions in Stoplight to use a custom TLS certificate.
• Shared Secret API key: At the end of the installation process, follow the prompt to copy your shared key to your clipboard
and store it somewhere secure. You'll use this key to authorize all API requests over HTTP.
Shure System API Resources
Stoplight: You can find comprehensive System API documentation in Stoplight , including:
• Step-by-step guides
• UML sequence diagrams
• More in-depth instructions on how to use the API
In Stoplight, you can generate code snippets for making HTTP requests in your preferred language to try things out in your ap
plication with minimal code adjustment.
Swagger: Swagger is available on the server where System API is installed. In Swagger, you can make requests against your
own devices running on your local device network and see information about endpoints when you don't have internet access.
By default, Swagger is available at https://127.0.0.1:10000/rest.
Supported Devices
The following Shure devices are supported in System API. Whenever possible, upgrade to the latest supported firmware ver
sion to take advantage of new features and system improvements.
Minimum Supported Version for De
Minimum Supported Version for Fea
Product vice Discovery and Firmware Update
ture Interactivity
Only
P300
ANIUSB
MXA310, MXA710, MXA901-R,
6.0.x All released firmware
MXA902, MXA910, MXA920
MXN5-C
MXA-NMB (Mute)
MXWANI4, MXWANI8 10.0.x All released firmware
4/5
Shure Incorporated
Minimum Supported Version for De
Minimum Supported Version for Fea
Product vice Discovery and Firmware Update
ture Interactivity
Only
MXWAPT2, MXWAPT4, MXWAPT8
MXW1 ('BPT'), MXW2 ('HHMT'),
MXW6 ('BMT'), MXW8 ('GMT')
MXWNCS2, MXWNCS4, MXWNCS8
QLXD4 2.5.x
ULXD4, ULXD4D, ULXD4Q
**ULXD6 ('BMT'), **ULXD8 ('GMT') 2.7.x All released firmware
SBC250, SBC450, SBC850
SBC220, SBC240 1.3.45
MXWAPDX2 All released firmware All released firmware
MXW1X ('BPT'), MXW2X ('HHMT'),
All released firmware All released firmware
MXW6X ('BMT')
**Only supports connectivity with SystemAPI when docked in SBC250/450/850 charger(s).
Important: Refer to the release notes for a list of compatible firmware versions.
5/5
