HTTP API позволяет получить программный доступ к большинству функций, доступных в личном кабинете: управление компьютерами, создание отложенных подключений.
Запросы
Все запросы должны выполняться по протоколу HTTPS (не HTTP) соответствующим методом для каждой команды по адресу https://api.getscreen.me/v1/
Ответы
Ответы с данными выдаются в JSON-формате в кодировке UTF-8 с ContentType: application/json . В каждом ответе данные оборачиваются в JSON-контейнер data
Коды ответов:
API-сервер может возвращать следующий HTTP-коды ответов:
HTTP-код ответа | Описание |
---|---|
200 OK | Запрос принят и обработан |
400 Bad Request | Запрос отклонен, неверные параметры, ошибка |
403 Forbidden | Запрос отклонен, к данным нет доступа |
404 Not Found | Запрос отклонен, неизвестный URL запроса |
Аутентификация
API является RESTful API — сервер не хранит состояние соединения с клиентом. Поэтому, при каждой отправке запроса клиент должен отправлять авторизационные данные. В качестве таких данных используется API-ключ. Добавляйте ключ в каждом запросе в параметре ?apikey=
https://api.getscreen.me/v1/?apikey=YOUR_API_KEY
Методы
Это команды для управления компьютерами и подключениями. Мы разделили их на несколько групп:
- Постоянный доступ
- Удаленная поддержка
- История подключений
Список компьютеров
Вы можете получить полный список компьютеров используя метод devices/agents
В контексте обращений к API компьютеры будут именоваться как «Агенты», потому что в техническом отношении управление компьютером осуществляется через программу агента
Запрос:
GET https://api.getscreen.me/v1/agents/list ?apikey=<string>
Параметры запроса:
Параметр | Тип | Значение |
---|---|---|
apikey * | string | API-ключ для авторизации запроса |
Ответ:
{ "data":[ { "id":1001, "name":"Allesandro Paci", "group":"Accounting", "disabled":false, "limited":false, "link_time":1587837997, "last_time":1600374761, "geo":{ "ip":"2.21.31.68", "country":"USA", "region":"California", "city":"Los Angeles" }, "permanent_url":"https://go.getscreen.me/paci", "preview_url":"https://getscreen.me/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png", "os":"win", "version":"1.9.4", "online":true, "installed":true, "favorite":false, "owner":"john.smith@gmail.com", "sessions":{ "last":{ "id":148505, "start_time":1600343858, "stop_time":1600343900, "client":{ "ip":"188.162.195.82", "country":"Russian Federation", "region":"Tatarstan", "city":"Kazan", "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36" } }, "total":121 } }, ... ] }
Данные ответа:
Название | Тип | Описание |
---|---|---|
id | number | Внутри-системный идентификатор |
name | string | Название |
group | string | Группа |
disabled | boolean |
Агент заблокирован?
К заблокированным агентам подключится нельзя. Блокировка наступает в случае превышения лимита по количеству компьютеров в тарифного плана. |
limited | boolean |
Агент лимитирован?
Агент становится лимитированным в случае превышения лимита тарифного плана по количестсву прикрепленных файлов. Через 10 дней после добавления лимитированный агент становится заблокированным. |
link_time | unixtime | Дата и время добавления в личный кабинет |
last_time | unixtime | Дата и время последнего состояния «в сети» |
geo | object | Гео-расположение |
geo.ip | string | IP-адрес |
geo.country | string | Страна |
geo.region | string | Регион |
geo.city | string | Город |
permanent_url | string |
Постоянный URL-адрес для подключения
Поле может отсутствовать, если доступ для неавторизованных пользователей закрыт |
preview_url | string | URL-адрес для загрузки превью рабочего стола |
os | string | Операционная система. Возможные значения: win, mac и linux |
version | string | Версия программы агента |
online | boolean | Текущее состояние «В сети» |
installed | boolean | Агент установлен на компьютере? |
favorite | boolean | Это избранный компьютер в списке в личном кабинете? |
owner | string | Учетная запись владельца доступа к компьютеру внутри системы |
sessions | object | Информация о подключениях |
sessions.last | object | Последнее подключение |
sessions.last.id | number | Внутри-системный идентификатор подключения |
sessions.last.start_time | unixtime | Дата и время начала подключения |
sessions.last.stop_time | unixtime |
Дата и время конца подключения
Поле может отсутствовать, если подключение активно |
sessions.last.client | object | Информация о клиенте (автор подключения) |
sessions.last.client.ip | string | IP-адрес |
sessions.last.client.country | string | Страна |
sessions.last.client.region | string | Регион |
sessions.last.client.city | string | Город |
sessions.last.client.user_agent | string | Юзер-агент браузера клиента |
sessions.total | object | Общее количество подключений |
Получить ссылку для подключения
Чтобы подключиться к компьютеру через API вам необходимо получить одноразовую ссылку, используя метод agents/connect
Полученная ссылка сгорает сразу же после первого использования. Вам нужно получать её каждый раз, когда вы хотите подключиться.
Запрос:
POST https://api.getscreen.me/v1/agents/connect ?apikey=<string> &agent_id=<number>
Параметры запроса:
Параметр | Тип | Значение |
---|---|---|
apikey * | string | API-ключ для авторизации запроса |
agent_id * | number | Внутри-системный идентификатор агента |
Ответ:
{ "data": { "url": "https://go.getscreen.me/john.smith/?connect=20177&llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab" } }
Данные ответа:
Название | Тип | Описание |
---|---|---|
url | string | URL-адрес для подключения |
Список открытых подключений
Чтобы получить список открытых подключений из раздела Удаленная поддержка воспользуйтесь методом support/list
Запрос:
GET https://api.getscreen.me/v1/support/list ?apikey=<string>
Параметры запроса:
Параметр | Тип | Значение |
---|---|---|
apikey * | string | API-ключ для авторизации запроса |
Ответ:
{ "remain":100, "data":[ { "id":328, "status":0, "create_time":1600262268, "invite_code":"408080316", "invite_url":"https://go.getscreen.me/invite/408080316", "connect_url":"https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx", "client_name":"Jacob Williams", "client_os":"", "client_preview_url":"" } ] }
Данные записи подключения:
Название | Тип | Описание |
---|---|---|
id | number | Внутри-системный идентификатор подключения |
status | number |
Статус подключения. Возможные значения:
|
create_time | unixtime | Дата и время создания подключения |
invite_code | string | Код для приглашения |
invite_url | string | URL-адрес для приглашения |
connect_url | string | URL-адрес для присоединения оператора к подключению |
client_name | string | Имя клиента |
client_os | string |
Операционная система. Возможные значения: win, mac и linux
Поле заполняется после присоединения клиента |
client_preview_url | string |
Миниатюра изображения рабочего стола клиента
Поле заполняется после присоединения клиента |
Дополнительные данные:
Название | Тип | Описание |
---|---|---|
remain | number | Количество оставшихся подключений в рамках тарифного плана |
Создать подключение
Чтобы создать отложенное подключение для удаленной поддержки используйте метод support/create
Запрос:
POST https://api.getscreen.me/v1/support/create ?apikey=<string> &client_name=<string>
Параметры запроса:
Параметр | Тип | Значение |
---|---|---|
apikey * | string | API-ключ для авторизации запроса |
client_name | string | Имя клиента (видно только вам). Необязательный параметр. |
Ответ:
{ "data":[ { "id":328, "status":0, "create_time":1600262268, "invite_code":"408080316", "invite_url":"https://go.getscreen.me/invite/408080316", "connect_url":"https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx", "client_name":"Jacob Williams", "client_os":"", "client_preview_url":"" } ] }
Присоединиться к подключению
Название | Тип | Описание |
---|---|---|
id | number | Внутри-системный идентификатор подключения |
status | number |
Статус подключения. Возможные значения:
|
create_time | unixtime | Дата и время создания подключения |
invite_code | string | Код для приглашения |
invite_url | string | URL-адрес для приглашения |
connect_url | string | URL-адрес для присоединения оператора к подключению |
client_name | string | Имя клиента |
client_os | string |
Операционная система. Возможные значения: win, mac и linux
Поле заполняется после присоединения клиента |
client_preview_url | string |
Миниатюра изображения рабочего стола клиента
Поле заполняется после присоединения клиента |
Информация о подключении
Чтобы получить информацию о конкретном подключении воспользуйтесь методом support/info
Запрос:
GET https://api.getscreen.me/v1/support/info ?apikey=<string> &connection_id=<number>
Параметры запроса:
Параметр | Тип | Значение |
---|---|---|
apikey * | string | API-ключ для авторизации запроса |
connection_id * | number | Внутри-системный идентификатор подключения |
Ответ:
{ "data":[ { "id":328, "status":2, "create_time":1600262268, "invite_code":"408080316", "invite_url":"https://go.getscreen.me/invite/408080316", "connect_url":"https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx", "client_name":"Jacob Williams", "client_os":"win", "client_preview_url":"https://pcommand.com/preview/f90d07668bccd418a5a8922f2ee455f1eb004c2bbeb5f9fe05ed6970c3389114Zl5PgknTWlU0fWBe4b9YoHNvRlD5Iwl5.png" } ] }
Данные ответа:
Название | Тип | Описание |
---|---|---|
id | number | Внутри-системный идентификатор подключения |
status | number |
Статус подключения. Возможные значения:
|
create_time | unixtime | Дата и время создания подключения |
invite_code | string | Код для приглашения |
invite_url | string | URL-адрес для приглашения |
connect_url | string | URL-адрес для присоединения оператора к подключению |
client_name | string | Имя клиента |
client_os | string |
Операционная система. Возможные значения: win, mac и linux
Поле заполняется после присоединения клиента |
client_preview_url | string |
Миниатюра изображения рабочего стола клиента
Поле заполняется после присоединения клиента |
Закрыть подключение
Чтобы закрыть подключение используйте метод support/close
Запрос:
POST https://api.getscreen.me/v1/support/close ?apikey=<string> &connection_id=<number>
Параметры запроса:
Параметр | Тип | Значение |
---|---|---|
apikey * | string | API-ключ для авторизации запроса |
connection_id * | number | Внутри-системный идентификатор подключения |
Ответ:
Ответ придет с пустым содержимым. Для анализа выполнения команды используйте только HTTP-код ответа.
Получить список подключений
Чтобы получить список ваших подключений используйте метод history/list
Запрос:
GET https://api.getscreen.me/v1/history/list ?apikey=<string> &agent_id=<number> &date_from=<unixtime> &date_to=<unixtime> &video=<boolean> &offset=<number> &limit=<number>
Параметры запроса:
Параметр | Тип | Значение |
---|---|---|
apikey * | string | API-ключ для авторизации запроса |
agent_id | number | Фильтр по идентификатору агента |
date_from | unixtime | Фильтр по дате и времени - начало периода |
date_to | unixtime | Фильтр по дате и времени - конец периода |
video | boolean | Фильтр по наличию видео-записи |
offset | number | Отступ первой позиции в списке |
limit | number | Количество позиций в списке. По умолчанию - 20, максимальное значение - 100 |
Ответ:
{ "offset": 0, "limit": 10, "total": 15, "filter": { "date_from": 1608660281, "date_to": 1608660389, "agent_id": 1001, "video": true }, "data": [ { "id": 27233, "start": 1608660273, "stop": 1608660281, "clients": [ { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36", "login": "john.smith@gmail.com", "geo": { "ip": "2.21.31.68", "country": "USA", "region": "California", "city": "Los Angeles" } } ], "agent": { "id": 1001, "name": "DESKTOP-SJBU5PO", "group": "Accounting", "geo": { "ip": "2.21.31.68", "country": "USA", "region": "California", "city": "Los Angeles" }, "os": "win", "version": "2.1.5", "owner": "john.smith@gmail.com" }, "video": { "url": "https://st1.getscreen.me/video/2/27233.mp4", "size": 428652 } }, ... ] }
Данные ответа:
Название | Тип | Описание |
---|---|---|
id | number | Внутри-системный идентификатор подключения |
start | unixtime | Дата и время начала подключения |
stop | unixtime |
Дата и время конца подключения
Может быть пустым, если подключение не завершено |
clients | array | Список клиентов, которые присоединялись к подключению |
clients[.]user_agent | string | Юзер-агент |
clients[.]login | string |
Логин пользователя
Может быть пустым, если подключение было анонимным |
clients[.]geo | object | Гео-расположение |
clients[.]geo.ip | string | IP-адрес |
clients[.]geo.country | string | Страна |
clients[.]geo.region | string | Регион |
clients[.]geo.city | string | Город |
agent | object | Информация об агенте |
agent.id | number | Внутри-системный идентификатор агента |
agent.name | string | Название |
agent.group | string | Группа |
agent.geo | object | Гео-расположение |
agent.geo.ip | string | IP-адрес |
agent.geo.country | string | Страна |
agent.geo.region | string | Регион |
agent.geo.city | string | Город |
agent.os | string | Операционная система. Возможные значения: win, mac и linux |
agent.version | string | Версия программы |
agent.owner | string | Логин учетной записи владельца постоянного доступа |
video | object |
Информация о видео-записи
Может отсутствовать, если видео-записи подключения не было |
video.url | string |
Адрес для загрузки видео-файла записи
Чтобы загрузить видео-файл записи подключения необходимо добавить параметр ?apikey= со значением вашего API-ключа. |
video.size | number | Размер видео-файла записи в байтах |