RuDesktop
API¶
API — раздел с описанием REST API сервера RuDesktop: получение токенов доступа и описание основных методов для интеграции с внешними системами и автоматизации рутинных операций
Авторизация¶
Все запросы к API авторизуются токеном в заголовке Authorization:
Authorization: Token [TOKEN]
Токен выпускается командой rude token create [имя_пользователя] (подробнее — в Настройке доступа)
Интерактивная схема API¶
Сервер предоставляет встроенную OpenAPI-схему и интерактивные интерфейсы для просмотра и тестирования эндпоинтов:
https://[SERVER_ADDR]/api/schema/— OpenAPI-схема в формате YAMLhttps://[SERVER_ADDR]/api/schema/swagger-ui/— интерактивный Swagger UIhttps://[SERVER_ADDR]/api/schema/redoc/— документация в формате ReDoc
Важно
Доступ к этим страницам разрешён только суперпользователю и осуществляется через сессионную авторизацию (вход в веб-интерфейс под суперпользователем)
Примечание
Схема включает все эндпоинты сервера, в том числе внутренние, используемые веб-интерфейсом и desktop-клиентом. Для интеграции с внешними системами через токен используйте методы, описанные в Функциях API
Получение и использование токена для доступа к API
Описание методов REST API по группам