Baixar
Soluções
Gerencie redes Ofereça suporte técnico Trabalhe desde casa Controle dispositivos Android
Integrações
Plug-ins API HTTP Agente SDK
Avaliações Planos tarifários
Mais
Recursos Guia Segurança Vantagens competitivas Artigos Tudo
Sobre nós Notícias Empresa
Ingressar via código
Plug-ins API HTTP Agente SDK
Encomendar integração

Integração usando API HTTP

Crie integrações únicas com suas plataformas.
Minimize o processo de conexão a alguns cliques.
Conteúdo:
Solicitações Respostas Autenticação Métodos Acesso permanente Lista de computadores Obtendo o link para conexão Suporte rápido Lista de conexões abertas Criando conexão Informações sobre a conexão Encerrando conexão Histórico de conexões Obtendo a lista de conexões

A API HTTP permite obter acesso programático à maioria das funções disponíveis dentro da área pessoal: gerenciamento de computadores, criação de conexões pendentes.

Solicitações

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

Respostas

As respostas de dados são dadas em formato JSON, codificação UTF-8 e ContentType: application/json . Em cada resposta, os dados são embrulhados em um contêiner JSON data

Códigos de resposta:

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

Códigos de resposta HTTP Descrição
200 OK Solicitação aceita e processada
400 Bad Request Solicitação rejeitada, parâmetros errados, erro
402 Payment Required Solicitação rejeitada, excedido o limite de solicitações do plano tarifário
403 Forbidden Solicitação rejeitada, não é possível acessar os dados
404 Not Found Solicitação rejeitada, URL desconhecida

Autenticação

A API é uma API RESTful, o que significa que o servidor não armazena o estado da conexão com o cliente. Por isso, cada vez que uma solicitação é enviada, o cliente tem que enviar dados de autorização. Esses dados são utilizados como chave API. Adicione a chave em cada solicitação no parâmetro ?apikey=

https://api.getscreen.me/v1/?apikey=YOUR_API_KEY
Sua chave API pode ser encontrada em sua área pessoal na seção "Integrações" na guia API HTTP

Métodos

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

Lista de computadores

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

No contexto das chamadas API, os computadores serão chamados de "Agentes" porque, tecnicamente, o computador é controlado através do programa agente de controle

Solicitação:

GET https://api.getscreen.me/v1/agents/list
  ?apikey=<string>
Parâmetros da solicitação:
Parâmetro Tipo Valor
apikey  * string Chave API para autorização da solicitação

Resposta:

{
    "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 da resposta:
Nome Tipo Descrição
id number Identificador intrassistema
name string Nome
group string Grupo
disabled boolean
O agente está bloqueado?

Os agentes bloqueados não podem ser acessados. O bloqueio ocorre quando o número de computadores no plano é excedido.
limited boolean
O agente está limitado?

O agente é limitado se o número de arquivos anexos que corresponde ao plano atual for excedido. Após 10 dias de ser adicionado, o agente limitado é bloqueado.
link_time unixtime Data e hora da adição à área pessoal
last_time unixtime Data e hora do último status "on-line"
geo object Localização
geo.ip string Endereço IP
geo.country string País
geo.region string Região
geo.city string Cidade
permanent_url string
URL de conexão permanente

Este campo pode não estar presente se o acesso para usuários não autorizados for restrito
preview_url string URL para carregamento das prévias da área de trabalho
os string Sistema operacional. Possíveis valores: win, mac, linux e android
version string Versão do agente de controle
online boolean Status atual "On-line"
installed boolean O agente está instalado no computador?
favorite boolean Este é o computador preferido na lista de sua área pessoal?
owner string Conta do proprietário do acesso ao computador dentro do sistema
sessions object Informações sobre conexões
sessions.last object Última conexão
sessions.last.id number Identificador de conexão intrassistema
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 não estar presente se a conexão estiver ativa
sessions.last.client object Informações sobre o cliente (autor da conexão)
sessions.last.client.ip string Endereço 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

Obtendo o link para conexão

Para se conectar a um computador através da API, você precisa obter um link descartável usando o método agents/connect

O link recebido expira imediatamente após o primeiro uso. Você precisa obter um toda vez que quiser se conectar.

Solicitação:

POST https://api.getscreen.me/v1/agents/connect
  ?apikey=<string>
  &agent_id=<number>
Parâmetros da solicitação:
Parâmetro Tipo Valor
apikey  * string Chave API para autorização da solicitação
agent_id  * number Identificador do agente intrassistema

Resposta:

{
    "data": 
        {
            "url": "https://go.getscreen.me/john.smith/?connect=20177&llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
        }
}
Dados da resposta:
Nome Tipo Descrição
url string URL para conexão

Lista de conexões abertas

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

Solicitação:

GET https://api.getscreen.me/v1/support/list
  ?apikey=<string>
Parâmetros da solicitação:
Parâmetro Tipo Valor
apikey  * string Chave API para autorização da solicitação

Resposta:

{
    "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 de gravação de conexão:
Nome Tipo Descrição
id number Identificador de conexão intrassistema
status number
Status da conexão. Possíveis valores:
  • 0 - Nova conexão, à espera de que o cliente ingresse
  • 1 - Cliente conectado, à espera de que o operador ingresse
  • 2 - Conexão ativa, todos os participantes ingressaram
  • 3 - Conexão fechada
create_time unixtime Data e hora de criação de conexão
invite_code string Código de convite
invite_url string URL de convite
connect_url string URL para o operador ingressar
client_name string Nome do cliente
client_os string
Sistema operacional. Possíveis valores: win, mac, linux e android

Campo a ser preenchido após o cliente ingressar
client_preview_url string
Miniatura da área de trabalho do cliente

Campo a ser preenchido após o cliente ingressar
Dados adicionais:
Nome Tipo Descrição
remain number Número de conexões restantes aplicáveis ao plano tarifário

Criando conexão

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

Solicitação:

POST https://api.getscreen.me/v1/support/create
  ?apikey=<string>
  &client_name=<string>
Parâmetros da solicitação:
Parâmetro Tipo Valor
apikey  * string Chave API para autorização da solicitação
client_name string Nome do cliente (visível só para você). Parâmetro opcional.

Resposta:

{
    "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":""
        }
    ]
}
Estabelecendo conexão
Nome Tipo Descrição
id number Identificador de conexão intrassistema
status number
Status da conexão. Possíveis valores:
  • 0 - Nova conexão, à espera de que o cliente ingresse
  • 1 - Cliente conectado, à espera de que o operador ingresse
  • 2 - Conexão ativa, todos os participantes ingressaram
  • 3 - Conexão fechada
create_time unixtime Data e hora de criação de conexão
invite_code string Código de convite
invite_url string URL de convite
connect_url string URL para o operador ingressar
client_name string Nome do cliente
client_os string
Sistema operacional. Possíveis valores: win, mac, linux e android

Campo a ser preenchido após o cliente ingressar
client_preview_url string
Miniatura da área de trabalho do cliente

Campo a ser preenchido após o cliente ingressar

Informações sobre a conexão

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

Solicitação:

GET https://api.getscreen.me/v1/support/info
  ?apikey=<string>
  &connection_id=<number>
Parâmetros da solicitação:
Parâmetro Tipo Valor
apikey  * string Chave API para autorização da solicitação
connection_id  * number Identificador de conexão intrassistema

Resposta:

{
    "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 da resposta:
Nome Tipo Descrição
id number Identificador de conexão intrassistema
status number
Status da conexão. Possíveis valores:
  • 0 - Nova conexão, à espera de que o cliente ingresse
  • 1 - Cliente conectado, à espera de que o operador ingresse
  • 2 - Conexão ativa, todos os participantes ingressaram
  • 3 - Conexão fechada
create_time unixtime Data e hora de criação de conexão
invite_code string Código de convite
invite_url string URL de convite
connect_url string URL para o operador ingressar
client_name string Nome do cliente
client_os string
Sistema operacional. Possíveis valores: win, mac, linux e android

Campo a ser preenchido após o cliente ingressar
client_preview_url string
Miniatura da área de trabalho do cliente

Campo a ser preenchido após o cliente ingressar

Encerrando conexão

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

Solicitação:

POST https://api.getscreen.me/v1/support/close
  ?apikey=<string>
  &connection_id=<number>
Parâmetros da solicitação:
Parâmetro Tipo Valor
apikey  * string Chave API para autorização da solicitação
connection_id  * number Identificador de conexão intrassistema

Resposta:

A resposta chegará com o conteúdo vazio. Para analisar a execução do comando, utilize apenas o código de resposta HTTP.

Obtendo a lista de conexões

Veja sua lista de conexões, usando o método history/list

Solicitaçã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 da solicitação:
Parâmetro Tipo Valor
apikey * string Chave API para autorização da solicitação
agent_id number Filtrar por ID do 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 por gravação de vídeo
offset number Recuo do primeiro item da lista
limit number O número de itens na lista. O valor padrão é 20, o valor máximo, 100

Resposta:

{
   "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 da resposta:
Nome Tipo Descrição
id number Identificador de conexão intrassistema
start unixtime Data e hora de início da conexão
stop unixtime
Data e hora de término da conexão

Pode ficar em branco se a conexão não for completada
clients array Lista de clientes que ingressaram
clients[.]user_agent string Agente de usuário
clients[.]login string
Nome de usuário

Pode estar em branco se a conexão foi anônima
clients[.]geo object Localização
clients[.]geo.ip string Endereço IP
clients[.]geo.country string País
clients[.]geo.region string Região
clients[.]geo.city string Cidade
agent object Informações sobre o agente
agent.id number Identificador do agente intrassistema
agent.name string Nome
agent.group string Grupo
agent.geo object Localização
agent.geo.ip string Endereço IP
agent.geo.country string País
agent.geo.region string Região
agent.geo.city string Cidade
agent.os string Sistema operacional. Possíveis valores: win, mac, android e linux
agent.version string Versão do programa
agent.owner string Usuário da conta do proprietário do acesso permanente
video object
Informações sobre gravação de vídeo

Pode não estar presente se não houver gravação em vídeo da conexão
video.url string
Endereço para baixar o arquivo de vídeo da gravação

Para baixar o arquivo de vídeo da gravação da conexão, você deve adicionar o parâmetro ?apikey= com o valor de sua chave API.
video.size number Tamanho do arquivo de vídeo da gravação em bytes

Integração individual

Não tem recursos para integrar por conta própria?
Precisa de mais funções do que a API HTTP pode oferecer?
Desde um pequeno botão dentro de seu aplicativo até um fornecedor OEM de serviços de acesso remoto qualificado, estamos prontos para desenvolver uma integração personalizada para você.

Enviar pedido

Entraremos em contato com você em breve
Enviar pedido
Pedido enviado com sucesso!
Entraremos em contato com você em breve

Está faltando algo?

Se você não tiver suficientes métodos ou dados na API HTTP, envie-nos um e-mail para info@getscreen.me ou mande uma mensagem no bate-papo da área pessoal.
Consideraremos seu recado e tentaremos ajudá-lo.
Baixar Entrar Inscrever-se Planos tarifários Gerencie redes Ofereça suporte técnico Trabalhe desde casa Controle dispositivos Android
Plug-ins API HTTP Agente SDK Segurança Sobre nós Avaliações Notícias Status da infraestrutura Propor ideia Ingressar via convite
Guia de agente de controle Guia de conexão Guia de área pessoal Comparação com TeamViewer Comparação com AnyDesk Comparação com Chrome Remote Desktop Termos de uso do site Política de privacidade Política de cookies
E-mail: info@getscreen.me
© 2018-2022 Getscreen.me