Skip to content

Способы авторизации API-запроса

Для того чтобы любой вызов API Watcher был выполнен, в заголовке (HTTP Header) необходимо указать ключ авторизации. От используемого ключа зависят также права на выполнение тех или иных запросов и возвращаемые ответы.

Существуют следующие типы ключей:

  1. Системный x-vsaas-api-key используется для интеграции с биллингом. Этот ключ указан в настройках Watcher и действителен до тех пор, пока администратор не изменит его. Позволяет выполнять любые запросы с правами супер-администратора, кроме запроса токена для активации Агента.

    Пример использования

    curl -v -X GET -H 'x-vsaas-api-key: 7c75da8fb314183f1f825271898a3687' -H 'content-type: application/json' http://127.0.0.1/vsaas/api/v2/cameras

    Запрос вернет список всех камер, добавленных в Watcher, в отличие от п.3.

  2. x-vsaas-session следует использовать для реализации действий пользователя в разрабатываемом собственном приложении или веб-интерфейсе для Watcher. Возвращается в ответ на запрос /vsaas/api/v2/auth/login в параметре session. Ключ действует, пока не превышено ограничение на количество сессий (если оно задано в настройках Watcher или в настройках пользователя, в противном случае ключ действует бессрочно). Позволяет выполнять запросы в рамках прав пользователя, указанного в запросе login.

    Пример использования

    curl -v -X GET -H 'x-vsaas-session: W98uOoiMFf46SyE78RjWIZjsaVM' -H 'content-type: application/json' http://127.0.0.1/vsaas/api/v2/auth/whoami

    Запрос вернет все параметры пользователя, для которого открыта сессия.

  3. Пользовательский x-vsaas-api-key можно использовать для интеграции с биллингом (с ограничением прав) или для любой другой автоматизации. Этот ключ следует сгенерировать в профиле пользователя, и он будет действителен до тех пор, пока не будет изменен. Ключ необходимо использовать вместе с параметром x-vsaas-user: имя пользователя. Он позволяет выполнять запросы в рамках прав указанного пользователя.

    Пример использования

    curl -v -X GET -H 'x-vsaas-api-key: M8rT4KvfT3tZpCj34Qbk5CEt' -H 'x-vsaas-user: user1' -H 'content-type: application/json' http://127.0.0.1/vsaas/api/v2/cameras

    Запрос вернет список камер, видимых пользователю user1, в отличие от примера в п. 1.