HTTP API - Getscreen.me

A HTTP API permite que você obtenha acesso programático à maioria das funções disponíveis em sua conta pessoal: gerenciamento de computadores, criação de conexões pendentes.

Inquéritos

Todas as solicitações devem ser feitas por HTTPS (não HTTP) usando o método apropriado para cada comando em https://api.getscreen.me/v1/

Respostas

As respostas de dados são retornadas no formato JSON na codificação UTF-8 com ContentType:application/json . Em cada resposta, os dados são embalados em um contêiner JSON data

Códigos de resposta:

O servidor API pode retornar os seguintes códigos de resposta HTTP:

Código de resposta HTTP	Descrição
200 OK	Pedido aceito e processado
400 Bad Request	Solicitação rejeitada, parâmetros inválidos, erro
403 Forbidden	Pedido negado, sem acesso aos dados
404 Not Found	Solicitação negada, URL de solicitação desconhecida

Autenticação

A API é uma API RESTful - o servidor não armazena o estado da conexão do cliente. Portanto, cada vez que uma solicitação é enviada, o cliente deve enviar dados de autorização. Uma chave de API é usada como dados. Adicione a chave em cada solicitação no parâmetro ?apikey=

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

Sua chave de API está em sua conta pessoal na seção "Integrações" na guia HTTP API

Métodos

Estes são comandos para gerenciar computadores e conexões. Nós os dividimos em vários grupos:

Acesso permanente
- Lista de computadores
- Obtenha um link para se conectar
Suporte rápido
Histórico de conexão
- Obtenha uma lista de conexões

Lista de computadores

Você pode obter uma lista completa de computadores usando o método devices/agents

No contexto das chamadas de API, os computadores serão referidos como "Agentes", porque tecnicamente um computador é controlado por meio do programa agente

Investigação:

GET https://api.getscreen.me/v1/agents/list
  ?apikey=<string>

Parâmetros de solicitação:

Parâmetro	Um tipo	Valor
apikey *	string	Chave API para autorizar o pedido

Responder:

{
    "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
            }
        },
        ...
    ]
}

Dados de resposta:

Title	Um tipo	Descrição
id	number	Identificador intra-sistema
name	string	Title
group	string	Grupo
disabled	boolean	O agente está bloqueado? Você não pode se conectar a agentes bloqueados. O bloqueio ocorre em caso de ultrapassagem do limite de número de computadores do plano tarifário.
limited	boolean	O agente é limitado? O agente fica limitado se o limite do plano tarifário para o número de anexos for ultrapassado. 10 dias após ser adicionado, o agente limitado é bloqueado.
link_time	unixtime	Data e hora de adicionar à sua conta pessoal
last_time	unixtime	Data e hora do último estado online
geo	object	Geo-localização
geo.ip	string	Endereço de IP
geo.country	string	País
geo.region	string	Região
geo.city	string	Cidade
permanent_url	string	URL de conexão permanente O campo pode estar ausente se o acesso para usuários não autorizados for fechado
preview_url	string	URL para baixar a visualização da área de trabalho
os	string	Sistema operacional. Valores possíveis: win, mac, linux e android
version	string	Versão do programa do agente
online	boolean	Status atual "Online"
installed	boolean	O agente está instalado no computador?
favorite	boolean	Este é um computador selecionado na lista da sua conta pessoal?
owner	string	A conta do proprietário de acesso ao computador dentro do sistema
sessions	object	Informação de conexão
sessions.last	object	Última conexão
sessions.last.id	number	ID de conexão no sistema
sessions.last.start_time	unixtime	Data e hora de início da conexão
sessions.last.stop_time	unixtime	Data e hora de término da conexão O campo pode estar ausente se a conexão estiver ativa
sessions.last.client	object	Informações do cliente (autor de conexão)
sessions.last.client.ip	string	Endereço de IP
sessions.last.client.country	string	País
sessions.last.client.region	string	Região
sessions.last.client.city	string	Cidade
sessions.last.client.user_agent	string	Agente de usuário do navegador do cliente
sessions.total	object	Número total de conexões

Obtenha um link para se conectar

Para se conectar a um computador via API, você precisa obter um link único usando o método agents/connect

O link resultante expira imediatamente após o primeiro uso. Você precisa obtê-lo sempre que quiser se conectar.

Investigação:

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

Parâmetros de solicitação:

Parâmetro	Um tipo	Valor
apikey *	string	Chave API para autorizar o pedido
agent_id *	number	Identificador do agente no sistema

Responder:

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

Dados de resposta:

Title	Um tipo	Descrição
url	string	Url de conexão

Lista de conexões abertas

Para obter uma lista de conexões abertas da seção Suporte rápido, use o método support/list

Investigação:

GET https://api.getscreen.me/v1/support/list
  ?apikey=<string>

Parâmetros de solicitação:

Parâmetro	Um tipo	Valor
apikey *	string	Chave API para autorizar o pedido

Responder:

{
    "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":""
        }
    ]
}

Dados do registro de conexão:

Title	Um tipo	Descrição
id	number	ID de conexão no sistema
status	number	Status da conexão. Valores possíveis: 0 - Nova conexão, conexão de cliente pendente 1 - Cliente conectado, a operadora entrará 2 - Conexão ativa, todos os participantes ingressaram 3 - Conexões fechadas
create_time	unixtime	Data e hora em que a conexão foi criada
invite_code	string	Código de Convite
invite_url	string	URL para convite
connect_url	string	O url para anexar a operadora à conexão
client_name	string	Nome do cliente
client_os	string	Sistema operacional. Valores possíveis: win, mac, linux e android O campo é preenchido após o cliente entrar
client_preview_url	string	Miniatura da área de trabalho do cliente O campo é preenchido após o cliente entrar

Dados adicionais:

Title	Um tipo	Descrição
remain	number	O número de conexões restantes dentro do plano tarifário

Criar conexão

Para criar uma conexão pendente para suporte remoto, use o método support/create

Investigação:

POST https://api.getscreen.me/v1/support/create
  ?apikey=<string>
  &client_name=<string>

Parâmetros de solicitação:

Parâmetro	Um tipo	Valor
apikey *	string	Chave API para autorizar o pedido
client_name	string	Nome do cliente (visível apenas para você). Parâmetro opcional.

Responder:

{
    "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":""
        }
    ]
}

Junte-se à conexão

Title	Um tipo	Descrição
id	number	ID de conexão no sistema
status	number	Status da conexão. Valores possíveis: 0 - Nova conexão, conexão de cliente pendente 1 - Cliente conectado, a operadora entrará 2 - Conexão ativa, todos os participantes ingressaram 3 - Conexões fechadas
create_time	unixtime	Data e hora em que a conexão foi criada
invite_code	string	Código de Convite
invite_url	string	URL para convite
connect_url	string	O url para anexar a operadora à conexão
client_name	string	Nome do cliente
client_os	string	Sistema operacional. Valores possíveis: win, mac, linux e android O campo é preenchido após o cliente entrar
client_preview_url	string	Miniatura da área de trabalho do cliente O campo é preenchido após o cliente entrar

Informação de conexão

Para obter informações sobre uma conexão específica, use o método support/info

Investigação:

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

Parâmetros de solicitação:

Parâmetro	Um tipo	Valor
apikey *	string	Chave API para autorizar o pedido
connection_id *	number	ID de conexão no sistema

Responder:

{
    "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"
        }
    ]
}

Dados de resposta:

Title	Um tipo	Descrição
id	number	ID de conexão no sistema
status	number	Status da conexão. Valores possíveis: 0 - Nova conexão, conexão de cliente pendente 1 - Cliente conectado, a operadora entrará 2 - Conexão ativa, todos os participantes ingressaram 3 - Conexões fechadas
create_time	unixtime	Data e hora em que a conexão foi criada
invite_code	string	Código de Convite
invite_url	string	URL para convite
connect_url	string	O url para anexar a operadora à conexão
client_name	string	Nome do cliente
client_os	string	Sistema operacional. Valores possíveis: win, mac, linux e android O campo é preenchido após o cliente entrar
client_preview_url	string	Miniatura da área de trabalho do cliente O campo é preenchido após o cliente entrar

Fechar conexão

Para fechar a conexão, use o método support/close

Investigação:

POST https://api.getscreen.me/v1/support/close
  ?apikey=<string>
  &connection_id=<number>

Parâmetros de solicitação:

Parâmetro	Um tipo	Valor
apikey *	string	Chave API para autorizar o pedido
connection_id *	number	ID de conexão no sistema

Responder:

A resposta virá com conteúdo vazio. Use apenas o código de resposta HTTP para analisar a execução do comando.

Obtenha uma lista de conexões

Para obter uma lista de suas conexões, use o método history/list

Investigação:

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>

Parâmetros de solicitação:

Parâmetro	Um tipo	Valor
apikey *	string	Chave API para autorizar o pedido
agent_id	number	Filtrar por ID de agente
date_from	unixtime	Filtrar por data e hora - início do período
date_to	unixtime	Filtrar por data e hora - fim do período
video	boolean	Filtrar pela presença de uma gravação de vídeo
offset	number	Recue a primeira posição na lista
limit	number	O número de itens na lista. O padrão é 20, o valor máximo é 100

Responder:

{
   "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
         }
      },
      ...
   ]
}

Dados de resposta:

Title	Um tipo	Descrição
id	number	ID de conexão no sistema
start	unixtime	Data e hora de início da conexão
stop	unixtime	Data e hora de término da conexão Pode estar vazio se a conexão não estiver completa
clients	array	Lista de clientes que aderiram à conexão
clients[.]user_agent	string	Agente de usuário
clients[.]login	string	Login de usuário Pode estar vazio se a conexão for anônima
clients[.]geo	object	Geo-localização
clients[.]geo.ip	string	Endereço de IP
clients[.]geo.country	string	País
clients[.]geo.region	string	Região
clients[.]geo.city	string	Cidade
agent	object	Informação do Agente
agent.id	number	Identificador do agente no sistema
agent.name	string	Title
agent.group	string	Grupo
agent.geo	object	Geo-localização
agent.geo.ip	string	Endereço de IP
agent.geo.country	string	País
agent.geo.region	string	Região
agent.geo.city	string	Cidade
agent.os	string	Sistema operacional. Valores possíveis: win, mac, linux e android
agent.version	string	Versão do programa
agent.owner	string	Login da conta do proprietário de acesso permanente
video	object	Informações de gravação de vídeo Pode estar ausente se a gravação de vídeo não estiver conectada
video.url	string	Endereço para enviar arquivo de gravação de vídeo Para carregar o arquivo de vídeo da gravação da conexão, você precisa adicionar o parâmetro ?apikey= com o valor de sua chave API.
video.size	number	Gravando o tamanho do arquivo de vídeo em bytes

Integração usando HTTP API

Inquéritos

Respostas

Códigos de resposta:

Autenticação

Métodos

Lista de computadores

Investigação:

Parâmetros de solicitação:

Responder:

Dados de resposta:

Obtenha um link para se conectar

Investigação:

Parâmetros de solicitação:

Responder:

Dados de resposta:

Lista de conexões abertas

Investigação:

Parâmetros de solicitação:

Responder:

Dados do registro de conexão:

Dados adicionais:

Criar conexão

Investigação:

Parâmetros de solicitação:

Responder:

Junte-se à conexão

Informação de conexão

Investigação:

Parâmetros de solicitação:

Responder:

Dados de resposta:

Fechar conexão

Investigação:

Parâmetros de solicitação:

Responder:

Obtenha uma lista de conexões

Investigação:

Parâmetros de solicitação:

Responder:

Dados de resposta:

Integração individual

Envie sua aplicação

Algo está faltando?