Page is loading ...
ClickShare API
2 Application
When a room controller is available to control the technical equipment in
the meeting room, the ClickShare API can be used to send commands to the
ClickShare Base Unit to change the settings as required. Here is an example:
The meeting room is equipped with a ClickShare CSC Base Unit, a video
conferencing system, and two displays.
•
When the meeting organizer wants to run a video conference, he/she wants
Display 1 to show the camera image of the video conferencing system, while
Display 2 shows content shared with ClickShare.
•
However, when there is no video conference, and all meeting participants are
present in the room, the meeting organizer wants the CSC Base Unit to show
the ClickShare content on both Display 1 and Display 2. With the ClickShare API
and a room controller, the integrator can program the room controller so that
the meeting organizer can easily choose between the two scenarios and trigger
the correct settings on the ClickShare Base Unit.
1 Use case
In many cases, ClickShare is installed with
other equipment in the meeting room,
which can include room controllers of various
types and brands that are used to control
the equipment in the room. To enable easy
integration with room controllers, ClickShare
offers an application programming interface
(API) on both the CSM and the CSC Base Units.
Integrating ClickShare with room controllers
and management systems
ROOM CONTROLLER
VC CODEC
ROOM CONTROLLER
VC CODEC
Video Conference:
ClickShare uses one display
Room Controller
touch panel
No Video Conference:
ClickShare uses both displays
3 API format
3.1 REST (Representational State Transfer)
The ClickShare Base Units offer a web API implemented using HTTP and REST principles. This is a collection of resources,
with four defined aspects:
• the base URI for the web API, such as http://example.com/resources/
• the Internet media type of the data supported by the web API. This is often JSON, but it can be any other valid
Internet media type provided that it is a valid hypertext standard.
• the set of operations supported by the web API using HTTP methods (e.g., GET, PUT, POST, or DELETE).
• the API must be hypertext-driven.
3.2 Requesting information
Example: requesting the software version number of a particular ClickShare Base Unit:
request "GET /v1/Software/Version"
response {
“status”: “200”,
“message”: “GET successful”,
“data”: {
“key”: “/v1/Software/Version”,
“value”: “01.04.00.0574”
}
}
3.3 Changing a setting
Example: changing the display mode of the CSC Base Unit from “single” to “extended”:
request “PUT /v1.0/Display/Mode --data {“value”:”Extended”}”
response {
“status”:”200”,
“messages”: “PUT successful”,
“data”:
{
“key”: “/v1.0/Display/Mode”,
“value”: “Extended”
}
}
3.4 Feedback
If the response is OK, the key-value pair will be returned in JSON format. Both GET and PUT methods will be accompanied
by the HTTP status code:
• “200” means OK,
• “404” means the resource was not found,
• “500” means there was an internal server error.
The type of resource can be string, number, object, array or boolean.
3.5 Security
In the first release, the REST API will be offered over HTTP. Authentication is necessary to access the API and will
be offered via Digest access authentication.
/