External Williams AV Infinium REST API (1.0)

The Infinium system supports remote control through its REST API (Representational State Transfer Application Programming Interface). This API provides a standardized set of rules and conventions that enable third-party control systems—such as Q-Sys, Crestron, Extron, or AMX—to perform the same functions as are available through the Infinium Web UI.

Using standard HTTP methods like GET, POST, PUT, and DELETE, third-party controllers can:

• Switch source or retrieve currently selected source for a channel

• Change DSP settings or presets

• Retrieve and display system status

• Set or retrieve passcodes for channel access

• Change or retrieve current IP Addresses, Subnet mask, and Gateway

• …and much more

This allows seamless integration of Infinium into a variety of control environments.

Before configuring commands in a control system, the first step is to generate an API Key. This key is required for all commands sent to the Infinium Controller and must be included in the command structure.
So it should be created before any programming begins. This is done using the web UI.

Step 1 Navigate to the tab where the API Key generation function is shown:

Step 2 Click on “Generate a new API Key” and enter a name for the key:

Step 3: Once a name is typed into the box, the “Generate Key” button will turn blue, indicating the key is ready to be generated.

Step 4: Once the generate key button has been pressed, the screen will show a blanked out key name.

Step 5: To see the key that was generated, and have the ability to copy the key, click on the eye symbol shown under “Actions”.

Step 6: Copy the key and save it somewhere for use when constructing the API commands.

Here is an example of setting channel 1 audio source settings. This shows just the objects; the structure of the command is obtained below.

• API: Application Programming Interface

• REST: acronym for REpresentational State Transfer, an architectural style for distributed hypermedia systems

• Resources: REST APIs are based on the concept of resources. A resource can be any information that can be named, such as a document, an image, or a collection of other resources. This typically lives in a database.

• GET: Retrieves data from a Controller resource

• POST: Creates a new entry (resource) in the Controller database

• PUT: Updates an existing entry (resource) in the Controller database

• DELETE: Removes an entry (resource) in the Controller database

• cURL: The term "cURL" stands for "Client for URLs" or "Client URL". It is a command-line tool and a library (libcurl) used for transferring data to and from a server using URL syntax. cURL supports a variety of protocols, including HTTP, HTTPS, FTP, and more, making it a versatile tool for interacting with web servers and APIs.