HTTP API - Getscreen.me

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

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

方法

这些是用于管理计算机和连接的命令。我们将它们分为几组：

永久访问
- 计算机列表
- 获取链接以连接
快速支持
连接历史
- 获取连接列表

计算机列表

您可以使用方法 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	永久连接网址如果未授权用户的访问被关闭，该字段可能不存在
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	系统内连接 ID
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	连接网址

打开的连接列表

要从快速支持部分获取打开的连接列表，请使用方法 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	系统内连接 ID
status	number	连接状态。可能的值： 0 - 新连接，等待客户端连接 1 - 客户端已连接，接线员将加入 2 - 活跃连接，所有参与者已加入 3 - 封闭连接
create_time	unixtime	创建连接的日期和时间
invite_code	string	邀请代码
invite_url	string	邀请地址
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	系统内连接 ID
status	number	连接状态。可能的值： 0 - 新连接，等待客户端连接 1 - 客户端已连接，接线员将加入 2 - 活跃连接，所有参与者已加入 3 - 封闭连接
create_time	unixtime	创建连接的日期和时间
invite_code	string	邀请代码
invite_url	string	邀请地址
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	系统内连接 ID

回答：

{
    "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	系统内连接 ID
status	number	连接状态。可能的值： 0 - 新连接，等待客户端连接 1 - 客户端已连接，接线员将加入 2 - 活跃连接，所有参与者已加入 3 - 封闭连接
create_time	unixtime	创建连接的日期和时间
invite_code	string	邀请代码
invite_url	string	邀请地址
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	系统内连接 ID

回答：

答案将带有空内容。仅使用 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	按代理 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,
      "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	系统内连接 ID
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 和 android
agent.version	string	程序版本
agent.owner	string	登录永久访问所有者的帐户
video	object	录像信息如果未连接视频录制，则可能不存在
video.url	string	录像文件上传地址要上传连接的视频文件记录，你需要添加?apikey=参数，其中包含你的API密钥值。
video.size	number	以字节为单位录制视频文件大小

使用 HTTP API 集成

查询

答案

答案代码：

验证

方法

计算机列表

询问：

请求参数：

回答：

响应数据：

获取链接以连接

询问：

请求参数：

回答：

响应数据：

打开的连接列表

询问：

请求参数：

回答：

连接记录数据：

附加数据：

创建连接

询问：

请求参数：

回答：

加入连接

连接信息

询问：

请求参数：

回答：

响应数据：

关闭连接

询问：

请求参数：

回答：

获取连接列表

询问：

请求参数：

回答：

响应数据：

个人整合

提交您的申请

缺了点什么？