Does ClickShare have an API for 3rd party integration?

Article number: [3484] - Legacy code: [11350]

Applicable to

ClickShare can be integrated with 3rd party systems through a REST API. This API is available on all models, but the API is different between CS(E) models and CX models.

API for CS-100(Huddle), CSE-200, CSE-200+ and CSE-800

The API for CS(E) models is referred to as the V1 API. 

The specification for this API can be found here.

The default username and password are integrator/integrator and can be changed in the web Configurator under Security > Passwords.

Make sure the Remote control via API is enabled in the web configurator under Wi-Fi & Network > Services.

To integrate the ClickShare CS(E) models with control systems, specific modules can be found on the resp. vendor's website, see KB 3677 for details.

 

API for CX-20, CX-30, CX-50, C-5 and C-10

The API for CX and C models is referred to as the V2 API. This API is only available for the models, which do not support the V1 API spec. Note that this API is only available as of firmware update 2.5. Make sure your Base Units are up to date at all times.

The specification for this API can be found in the web configurator of the device. You will find the spec under Wi-Fi & Network > Services. Make sure the option Remote control via API is enabled to use the REST API.

Click on View API documentation and then enter the ClickShare Web configurator credentials (username: admin, password: admin) to access the swagger interface. To access the web configurator (how to: see KB 2324).

The specification for this API can also be found here.

In the V2 API, the username and password have been unified with the web configurator's credentials. The default username and password are admin/admin and can be changed in the Security > Passwords section of the web configurator.

To integrate the ClickShare CX and C models with control systems, specific modules will be available soon on the resp. vendor's website.

See the video below to learn how to use Rest API with ClickShare.

Properties

Last updated Sep 13, 2023