Общий вид запроса

В зависимости от задачи, Вы можете работать с SDK через указание пароля SDK, явное указание логина\пароля произвольного пользователя в каждом запросе, либо использовать сессии.

Если в запросе не указать имя пользователя, а указать только пароль, то система будет считать что работа ведется через пароль SDK с правами пользователя Script, если имя пользователя будет указано, то работа будет вестись с правами этого пользователя. Для того, чтобы каждый раз не передавать логин и пароль в запросе, Вы можете использовать сессии, кроме того некоторые команды требуют обязательного наличия сессии.

Общий вид запроса с указанием пароля SDK: 

        https://адрес_сервера:порт/команда?password=пароль

Общий вид запроса с указанием логина\пароля произвольного пользователя: 

        https://адрес_сервера:порт/команда?username=пользователь&password=пароль

Общий вид запроса с использованием сессии: 

        https://адрес_сервера:порт/команда?sid=id_сессии

Ключевые элементы запроса:

  • адрес_сервера - ip-адрес сервера в формате Ipv4, либо его NetBios-имя, пример: 192.168.1.1, либо videoserver;
  • порт - порт сервера для подключения к SDK, пример: 8080;
  • команда - сам запрос, который необходимо выполнить, пример: health;
  • пользователь - имя пользователя, под которым будет вестись работа, пример: Admin;
  • пароль - пароль пользователя, пример: 987654321;
  • id_сессии - id полученной сессии, пример: e03qD0eg;

Подсказка

Обратите внимание, что запрос обязательно должен начинаться с https:// (работа идет по протоколу HTTPS).

Примеры запросов: 

        https://192.168.1.200:8080/health?username=Admin&password=987654321
        https://192.168.1.200:8080/health?password=12345
        https://192.168.1.200:8080/health?sid=e03qD0eg

В примерах запросов описанных выше данные передаются на сервер методом GET. Так же, Вы можете использовать метод передачи POST. Ниже приведен пример простой html-формы иллюстрирующий этот принцип: 

        <html>
            <body>
                <form action="https://192.168.1.200:8000/objects/" method="POST">
                <label for="password">Введите пароль SDK:</label>
                <input id="password" type="password" name="password">
                <input type="submit" value="Отправить">
                </form>
            </body>
        </html>

Далее, в рассматриваемых примерах везде будет использоваться метод передачи GET с использованием сессии.

См. также