Как выпускается ключ
Ключ выпускается в кабинете организации, действует от имени выбранной роли и только в пределах отмеченных при создании прав. Ключ показывается один раз в момент создания - сохраните его сразу, повторно посмотреть не получится. В интерфейсе кабинета виден только короткий префикс ключа, сам ключ хранится хешем.
Доступно на тарифах Pro и выше.
Права
Восемь публичных прав:
| Право | Что открывает |
|---|---|
read:devices | Чтение списка устройств организации и их параметров |
write:devices | Изменение данных об устройствах и их состояния |
read:sessions | Чтение истории и текущих сессий |
read:recordings | Просмотр списка записей сессий и получение ссылок на скачивание |
write:recordings | Изменение и удаление записей сессий |
read:audit | Чтение журнала аудита |
read:users | Чтение списка пользователей организации и их ролей |
write:users | Изменение данных пользователей и их ролей |
Как передавать ключ
Ключ передаётся в заголовке запроса:
X-API-Key: <ключ>
Часть методов API ключом недоступна в принципе - они требуют входа пользователя. При обращении к такому методу с ключом сервер вернёт явный отказ с объяснением.