Page 81
APPENDIX D: API Documentation
Introduction
This appendix discusses ways to use the Application Program Interface (API) to
allow third party equipment to remotely access options and settings of the iAM-
VIDEO. 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.
REST API iAM-Video Version 1.3
Get all available groups, sub-groups and presets:
URL: /api/cf/groups
Method:
GET
URL Parameters:
Not required
Response JSON Object
• string unit_name: Product Name ("iiAM-Video")
• string model: Product model ("iAM_VIDEO")
• string serial_number: Product serial number
• float version: Rest API’s version
• string result: List of available Groups, Sub-groups (Programs) and 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/groups
Example response:
{
"unit_name": "iAM-Video", "model": "iAM_VIDEO", "serial_number": "YYYYYY", "version":1.3,
"result":[...] }
Get all favorite presets:
URL: /api/cf/presets/favorite
Method:
GET
URL Parameters:
Not required
Response JSON Object
• string unit_name: Product Name ("iiAM-Video")
• string model: Product model ("iAM_VIDEO")
• string serial_number: Product serial number
• float version: Rest API’s version