HTTP API - Getscreen.me

HTTP API允许您以编程方式访问个人帐户中可用的大多数功能：计算机管理，创建延迟连接。

请求

所有请求必须通过HTTPS（而不是HTTP）通过每个命令的适当方法在https://api.getscreen.me/v1/

响应

带有数据的响应以UTF-8编码的JSON格式发出ContentType: application/json。在每个响应中，数据都包装在JSON容器中data

响应代码：

API服务器可以返回以下HTTP响应代码：

HTTP响应代码	资料描述
200 OK	申请已被接受并处理
400 Bad Request	申请被拒绝，参数无效，错误
402 Payment Required	申请被拒绝，超过了资费计划的申请限制
403 Forbidden	申请被拒绝，无法访问数据
404 Not Found	申请被拒绝，未知申请URL

认证

API是RESTful API - 服务器不存储与客户的连接状态。因此，每次发送申请时，客户都必须发送授权数据。 API密钥用作此类数据。在GET参数中的每个请求中添加一个键?apikey=或者在HTTP头中X-Api-Key

https://api.getscreen.me/v1/?apikey=YOUR_API_KEY

您的API密钥位于选项卡上"集成"部分HTTP API的个人帐户中

方法

这些是用于管理计算机和连接的命令。我们把他们分成几组：

永久访问
快速支持
连接历史
- 获取连接列表

计算机列表

您可以使用该方法获得计算机的完整列表agents/list

在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 如果未授权用户的访问被关闭，该字段可能会丢失
onetime_url	string	URL for one-time connection The link changes every 45 seconds The field may be missing if connections via single-use links are disabled in the agent settings
preview_url	string	下载桌面预览的URL
os	string	操作系统。可能的值：win，mac，linux和android
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	连接总数

电脑信息

要从永久访问部分获取有关计算机的信息，您需要使用该方法agents/info

申请：

GET https://api.getscreen.me/v1/agents/info
  ?apikey=<string>
  &agent_id=<number>

申请参数：

参数	类型	数值
apikey *	string	申请授权的API密钥
agent_id *	number	系统内部代理的ID

响应：

{
    "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",
        "onetime_url": "https://go.getscreen.me/am2-l2g",
        "preview_url": "https://getscreen.me/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os": "win",
        "version": "2.7.6",
        "online": true,
        "installed": true,
        "favorite": false,
        "owner": "john.smith@gmail.com",
        "hardware": {
            "BIOS": "ALASKA - 1072009 - F51 - American Megatrends - 5000E",
            "BIOSDate": "",
            "BIOSVersion": "20191218",
            "CPU": "AMD Ryzen 5 2600X Six-Core Processor",
            "CPUCores": 6,
            "CPUCoresLogical": 12,
            "CPUFamily": "AMD64 Family 23 Model 8 Stepping 2",
            "CPUSpeed": 3600,
            "ComputerDomain": "WORKGROUP",
            "ComputerIP": [
                "10.66.65.3",
                "fe80::35da:bb0:c661:fff9"
            ],
            "ComputerModel": "B450 AORUS ELITE",
            "ComputerName": "DESKTOP-AU0VQEE",
            "ComputerWorkgroup": "WORKGROUP",
            "HDD": [ {
                "Model": "INTEL SSDPEKNW512G8",
                "Size": 488382
            } ],
            "Locale": "0419",
            "LocaleCountry": "USA",
            "LocaleCurrency": "USD",
            "LocaleFormatDate": "MM-DD-YYYY",
            "LocaleFormatTime": "H:mm:ss",
            "LocaleOemPage": "437",
            "LocaleTimezone": -420,
            "LogicalDisks": [ {
                "Disk": "C:",
                "FileSystem": "NTFS",
                "FreeSpace": 13668,
                "Name": "",
                "Size": 487757
            } ],
            "Monitors": [ {
                "Name": "Universal PnP monitor",
                "ScreenHeight": 1080,
                "ScreenWidth": 1920
            } ],
            "NetAdapters": [ {
                "Addresses": "",
                "Cable": true,
                "DCHP": "",
                "DNS": "",
                "MACAddress": "18:C0:4D:44:F0:61",
                "Manufacturer": "Realtek",
                "Name": "Realtek Gaming GbE Family Controller",
                "Speed": 953,
                "WoL": true
            } ],
            "OSName": "Microsoft Windows 10 Pro",
            "OSVersion": "10.0.19044",
            "RAMBanks": [ {
                "Bank": "P0 CHANNEL A",
                "Capacity": 8192,
                "DataWidth": 64,
                "Locator": "DIMM 0",
                "Manufacturer": "Unknown",
                "PartNumber": "F4-3200C16-8GSXFB",
                "SerialNumber": "00000000"
            } ],
            "RAMPageFile": 51264,
            "RAMPhys": 32716,
            "RAMPhysAvail": 9380,
            "RAMVirt": 134217727,
            "RAMVirtAvail": 134213282,
            "SoundDevices": [ {
                "Name": "NVIDIA High Definition Audio"
            } ],
            "VideoCards": [ {
                "Integrated": true,
                "Name": "NVIDIA GeForce GT 710",
                "RAM": 1024
            } ],
            "VideoName": "NVIDIA GeForce GT 710",
            "VideoRAM": 1024
        },
        "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": 1
        }
    }
}

响应数据：

名称	类型	资料描述
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 如果未授权用户的访问被关闭，该字段可能会丢失
onetime_url	string	URL for one-time connection The link changes every 45 seconds The field may be missing if connections via single-use links are disabled in the agent settings
preview_url	string	下载桌面预览的URL
os	string	操作系统。可能的值：win，mac，linux和android
version	string	代理软件版本
online	boolean	«在线»状态
installed	boolean	计算机上是否安装了代理？
favorite	boolean	这是您个人帐户列表中最喜欢的计算机吗？
owner	string	访问系统内部计算机的所有者的帐户
hardware	object	系统信息
hardware.BIOS	string	BIOS信息
hardware.BIOSDate	string	更新日期
hardware.BIOSVersion	string	版本
hardware.CPU	string	处理器
hardware.CPUCores	number	核心数目
hardware.CPUCoresLogical	number	逻辑处理器数
hardware.CPUFamily	string	家庭
hardware.CPUSpeed	number	速度
hardware.ComputerDomain	string	域名
hardware.ComputerIP	array	IP地址
hardware.ComputerModel	string	模型
hardware.ComputerName	string	电脑名称
hardware.ComputerWorkgroup	string	工作小组
hardware.HDD	array	硬盘驱动器
hardware.HDD[].Model	string	模型
hardware.HDD[].Size	number	大小
hardware.Locale	string	区域设置
hardware.LocaleCountry	string	国家
hardware.LocaleCurrency	string	货币
hardware.LocaleFormatDate	string	日期格式
hardware.LocaleFormatTime	string	时间格式
hardware.LocaleOemPage	string	页面编码
hardware.LocaleTimezone	number	时区
hardware.LogicalDisks	array	逻辑磁盘
hardware.LogicalDisks[].Disk	string	Label
hardware.LogicalDisks[].FileSystem	string	文件系统类型
hardware.LogicalDisks[].FreeSpace	number	可用容量（MB)
hardware.LogicalDisks[].Name	string	名称
hardware.LogicalDisks[].Size	number	大小 (MB）
hardware.Monitors	array	显示器
hardware.Monitors[].Name	string	名称
hardware.Monitors[].ScreenHeight	number	屏幕高度
hardware.Monitors[].ScreenWidth	number	屏幕宽度
hardware.NetAdapters	array	网卡
hardware.NetAdapters[].Addresses	string	地址
hardware.NetAdapters[].Cable	boolean	通过LAN电缆连接互联网
hardware.NetAdapters[].DCHP	string	DCHP
hardware.NetAdapters[].DNS	string	DNS
hardware.NetAdapters[].MACAddress	string	MAC地址
hardware.NetAdapters[].Manufacturer	string	制造商
hardware.NetAdapters[].Name	string	名称
hardware.NetAdapters[].Speed	number	速度
hardware.NetAdapters[].WoL	boolean	启用Wake-on-LAN设置
hardware.OSName	string	操作系统名称
hardware.OSVersion	string	操作系统版本
hardware.RAMBanks	array	随机储存器
hardware.RAMBanks[].Bank	string	插槽
hardware.RAMBanks[].Capacity	number	容量
hardware.RAMBanks[].Locator	string	定位器
hardware.RAMBanks[].Manufacturer	string	制造商
hardware.RAMBanks[].PartNumber	string	零件编号
hardware.RAMBanks[].SerialNumber	string	序列编号
hardware.SoundDevices	array	声卡
hardware.SoundDevices[].Name	string	名称
hardware.VideoCards	array	视频卡
hardware.VideoCards[].Integrated	boolean	集成的
hardware.VideoCards[].Name	string	名称
hardware.VideoCards[].RAM	number	内存
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	系统内部代理的ID

响应：

{
    "data":{
        "url": "https://go.getscreen.me/john.smith/?connect=20177&llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
    }
}

响应数据：

名称	类型	资料描述
url	string	连接的URL

开放连接列表

要从快速支持部分获取打开的连接列表，请使用支持/列表方法

申请：

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	连接状态。可能的值： 0 - 新连接，等待客户连接 1 - 客户已连接，等待操作员加入 2 - 活动连接，所有参加者已加入 3 - 封闭式连接
create_time	unixtime	创建连接的日期和时间
invite_code	string	邀请的代码
invite_url	string	邀请的URL
connect_url	string	用于操作员加入连接的URL
client_name	string	客户名称
client_os	string	操作系统。可能的值：win，mac，linux和android 该字段在客户加入后填写
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	连接状态。可能的值： 0 - 新连接，等待客户连接 1 - 客户已连接，等待操作员加入 2 - 活动连接，所有参加者已加入 3 - 封闭式连接
create_time	unixtime	创建连接的日期和时间
invite_code	string	邀请的代码
invite_url	string	邀请的URL
connect_url	string	用于操作员加入连接的URL
client_name	string	客户名称
client_os	string	操作系统。可能的值：win，mac，linux和android 该字段在客户加入后填写
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://getscreen.me/preview/f90d07668bccd418a5a8922f2ee455f1eb004c2bbeb5f9fe05ed6970c3389114Zl5PgknTWlU0fWBe4b9YoHNvRlD5Iwl5.png"
    }
}

响应数据：

名称	类型	资料描述
id	number	系统内部身份证连接
status	number	连接状态。可能的值： 0 - 新连接，等待客户连接 1 - 客户已连接，等待操作员加入 2 - 活动连接，所有参加者已加入 3 - 封闭式连接
create_time	unixtime	创建连接的日期和时间
invite_code	string	邀请的代码
invite_url	string	邀请的URL
connect_url	string	用于操作员加入连接的URL
client_name	string	客户名称
client_os	string	操作系统。可能的值：win，mac，linux和android 该字段在客户加入后填写
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>
  &support_id=<number>
  &date_from=<unixtime>
  &date_to=<unixtime>
  &video=<boolean>
  &offset=<number>
  &limit=<number>

申请参数：

参数	类型	数值
apikey *	string	申请授权的API密钥
agent_id	number	按代理ID过滤
support_id	number	Sort by Quick Support connection ID
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,
        "support_id": 1002,
        "video": true
    },
    "data": [ {
        "id": 27233,
        "start": 1608660273,
        "stop": 1608660281,
        "support_id": 1002,
        "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	连接结束的日期和时间如果连接未完成，则可能为空
support_id	number	Quick Support connection ID The field may be blank if there was a connection to a Permanent Access device
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	内部的代理的系统ID
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，android和linux
agent.version	string	程序版本
agent.owner	string	永久登入帐户的注册名
video	object	录像信息如果没有视频录制连接，可能会丢失
video.url	string	上传视频录制文件的地址要上传连接录制视频文件，您需要添加一个参数?apikey=与您的API密钥的值。
video.size	number	以字节为单位的录制视频文件的大小

使用HTTP API集成

请求

响应

响应代码：

认证

方法

计算机列表

申请：

申请参数：

响应：

响应数据：

电脑信息

申请：

申请参数：

响应：

响应数据：

获取连接链接

申请：

申请参数：

响应：

响应数据：

开放连接列表

申请：

申请参数：

响应：

连接记录数据：

附加数据：

创建连接

申请：

申请参数：

响应：

加入连接

连接信息

申请：

申请参数：

响应：

响应数据：

关闭连接

申请：

申请参数：

响应：

获取连接列表

申请：

申请参数：

响应：

响应数据：

个人集成

留下申请

缺少什么了吗？