Api Fundamentals; Connecting To The Api; Password; Ssh - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec

Introduction

API fundamentals

This chapter contains a top-level view of the mechanisms
supported by the codec API.
Here you can read about how to access the API, how to use
the command line and what the different parts of the API can
be used for. Information on how to use the feedback functions
that are available for the codec is included in this chapter.
The API consists of four major groups:
• Commands
• Configurations
• Status
• Events
These four groups are hierarchically organized, which makes
it easier to find related functionality. You can find the complete
lists of all commands, configurations and statuses in the
following chapters.
SX20 Codec API Reference Guide CE8.3, JANUARY 2017.
D15316.05
About the API About the API xConfiguration

Connecting to the API

There are several ways to access the codec API. Regardless
of which method you choose, the structure of the API stays
the same. Choose the connection method that suits your
application best. Before you start, please read this section
about the different methods, as some of those may require
additional configuration changes before being enabled.
The following configurations, apart from password, can be set
from the System configuration menu on the web interface or
from the command line interface. All of the examples are for
the command line interface.

Password

The video system is delivered with a default user account
with full credentials. The user name is admin, and initially, no
password is set for the default user.
It is mandatory to set a password for the admin user in order to
restrict access to system configuration. You should in addition
set a password for any other user with similar credentials.
You can set the password on the codec's web interface. Open
a web browser and enter the IP address of the video system in
the address bar and log in. Click your user name in the upper
right corner and choose Change password in the drop down
menu.
xCommand

SSH

SSH is a secure TCP/IP connection and it is enabled by default
on the codec. It can be disabled. You need a SSH client, such
as PuTTY, to access the API over SSH.

Telnet

Telnet can be viewed as the equivalent of the serial proto-
col in the TCP/IP world. Telnet is disabled by default. Before
connecting to the codec with Telnet you have to enable it.
To enable Telnet service, configure the following setting on the
codec. Changing this setting does not require a reboot of the
device, but it may take some time to take effect.

HTTP/HTTPS

As HTTP/HTTPS are connectionless protocols, there is no
persistent connection. There are several ways of communicat-
ing with the API over HTTP.
In order to enable or disable the HTTP and HTTPS services,
configure the following setting on the codec.
Connecting
You can inspect the API by entering the IP-address or
host name of the codec in your favorite web browser. In
the web interface, you can find the API documents under
the menu section
POST and GET methods are used to execute commands
and get feedback from the codec. This is described in
"Using HTTP" on page 43
34
API Reference Guide
xStatus Appendices
xConfiguration NetworkServices SSH Mode:
<Off,On>
xConfiguration NetworkServices Telnet Mode:
<Off,On>
xConfiguration NetworkServices HTTP Mode:
<Off/HTTP+HTTPS/HTTPS>
Integration > Developer API. The HTTP
in this document.
Copyright © 2017 Cisco Systems, Inc. All rights reserved.