Модуль предназначен для предоставления доступа к функционалу платформы ROBIN через API, позволяя интегрировать платформу в свои приложения без необходимости использования веб-интерфейса.
Раздел доступен только пользователям с ролью "Администратор оркестратора" в текущем тенанте.
Для работы с API необходимо использовать токены доступа.
Некоторые методы (например, управление корзиной роботов) будут добавлены в будущих версиях платформы.
Вкладка «Машины»
На вкладке представлены методы API для работы с машинами и их учётными записями.
Список методов
| Метод | Описание | Пример использования |
|---|---|---|
GET /api/v1/hosts | Получение списка машин текущего тенанта | Вывод списка машин для выбора при настройке запуска робота |
GET /api/v1/hosts/host-users | Получение списка учётных записей машин | Вывод списка УЗ машин для настройки запуска робота |
GET /api/v1/hosts/host-users/{id} | Получение учётной записи машины | Просмотр дополнительной информации о выбранной УЗ машины |
PATCH /api/v1/hosts/host-users/{id} | Изменение учётной записи машины | Обновление описания УЗ для других пользователей |
POST /api/v1/accounts | Указание логина и пароля УЗ машины | Добавление данных для RDP-сессии при запуске робота |
PATCH /api/v1/accounts/{id} | Изменение логина и пароля УЗ машины | Обновление данных для корректного запуска RDP-сессии |
Вкладка «Роботы»
На вкладке представлены методы API для работы с роботами и их запусками.
Список методов
Опубликованные роботы
| Метод | Описание | Пример использования |
|---|---|---|
GET /api/v1/robot-packages/{id} | Получение робота | Просмотр описания изменений конкретной версии робота |
GET /api/v1/robot-packages/all | Получение списка всех роботов | Вывод списка версий роботов для выбора |
POST /api/v1/robots/start | Запуск робота | Ручной запуск робота пользователем |
GET /api/v1/robots/{id} | Получение запуска робота | Просмотр статуса конкретного запуска |
Управление запусками
| Метод | Описание | Пример использования |
|---|---|---|
GET /api/v1/robots | Получение списка запусков | Просмотр статусов запусков за сегодня |
PATCH /api/v1/robots/{id}/stop | Завершение работы робота | Остановка некорректно работающего робота |
PATCH /api/v1/robots/{id}/pause | Приостановка работы робота | Временная остановка запуска |
GET /api/v1/robots/{id}/logs/download-token | Получение токена для скачивания лога | Скачивание лога выполнения робота |
Вкладка «Очереди ресурсов»
На вкладке представлены методы API для работы с очередями ресурсов.
Список методов
Очереди ресурсов
| Метод | Описание | Пример использования |
|---|---|---|
POST /api/v1/queues | Создание очереди | Создание очереди для использования роботом |
DELETE /api/v1/queues/{id} | Удаление очереди | Удаление устаревшей очереди |
GET /api/v1/queues | Получение списка очередей | Просмотр текущего объёма работы роботов |
Ресурсы в очереди
| Метод | Описание | Пример использования |
|---|---|---|
GET /api/v1/external-resources/{id} | Получение ресурса | Проверка статуса обработки ресурса |
PATCH /api/v1/external-resources/{id} | Изменение ресурса | Изменение приоритета ресурса |
Обзор
Инструменты контента