Page
72
APPENDIX D: API Documentation
Introduction
This appendix discusses ways to use the Application Program Interface (API)
Version 2, which allows third party equipment to remotely access options and
settings of the iAM-MIX. It includes specific code examples for commonly used
requests. The API uses JavaScript Object Notation (JSON) as its communication
language.
Follow the instructions in the
First Time IP Assignments
section of Chapter 4 to
achieve the required network connection.
API: Presets
Get available presets
:
Method: GET
URL: /api/cf/presets
Response JSON Object
•
string
unit_name
:
Product Name ("IAM-ETZ-G4")
•
string
model:
Product model ("iAM_MIX_IP")
• string
serial_numbe
r
:
Product serial number
•
float
api_version
:
REST API version
•
string
result
List of Presets without configuration data.
Status Codes:
•
200
OK
•
400
Bad Request
Invalid URL
•
404
Data Not Found
Invalid HTTP method request
•
500
Server Error
Internal Server Error
Example request
:
GET /api/cf/presets
Example response
:
{
"unit_name": "MIX-XHGCTV",
"model": "iAM-Mix-IP",
"api_version": 2,
"serial_number": "123456",
"result": [
{
"Favorite": 1,
"Id": 1,
"Name": "Preset Name 1"
},
Содержание iAM-MIX-16
Страница 19: ...Page 19 To cancel the reset process press RESET NO or press EXIT MENU ...
Страница 23: ...Page 23 Figure 3 1 iAM MIX Block Diagram ...
Страница 69: ...Page 69 ...