Plugins HTTP API Agent SDK
Ordenar la integración

Integración usando el HTTP API

Crea integraciones únicas con tus plataformas.
Simplifica la conexión con sólo un par de clic.

La HTTP API proporciona acceso de software a la mayoría de las funciones disponibles en tu cuenta personal: administrar ordenadores, crear conexiones diferidas.

Solicitudes

Todas las solicitudes deben ser ejecutadas a través del protocolo HTTPS (no HTTP) utilizando el método apropiado para cada comando en la dirección https://api.getscreen.me/v1/

Respuestas

Las respuestas con datos se publican en formato JSON codificado UTF-8 desde ContentType: application/json . En cada respuesta, los datos se empaquetan en un contenedor JSON data

Códigos de respuestas:

El servidor API puede devolver los siguientes códigos de respuesta HTTP:

Código de respuesta HTTP Descripción
200 OK Solicitud aceptada y procesada
400 Bad Request Solicitud rechazada, parámetros incorrectos, error
403 Forbidden Solicitud rechazada, sin acceso a los datos
404 Not Found Solicitud rechazada, URL de solicitud desconocida

Autenticación

La API es un RESTful API: el servidor no almacena el estado de la conexión con el cliente. Por consiguiente, cada vez que se envía una solicitud, el cliente debe enviar los datos de autorización. La clave API se utiliza como dichos datos. Agrega una clave a cada solicitud en el parámetro ?apikey=

https://api.getscreen.me/v1/?apikey=YOUR_API_KEY
Su clave API se puede encontrar en su gabinete personal en la sección "Integración" de la pestaña HTTP API

Métodos

Estos son comandos para controlar los ordenadores y las conexiones. Los dividimos en varios grupos:


Lista de ordenadores

Puedes obtener la lista completa de ordenadores usando el método devices/agents

En el contexto de las llamadas a la API, los ordenadores se denominarán «Agentes» porque, en términos técnicos, el control de los ordenadores se realiza a través de un programa de agente

Solicitud:

GET https://api.getscreen.me/v1/agents/list
  ?apikey=<string>
Parámetros de solicitud:
Parámetro Tipo Valor
apikey  * string API clave para autorizar la solicitud

Respuesta:

{
    "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
            }
        },
        ...
    ]
}
Datos de respuesta:
Nombre Tipo Descripción
id number Identificador intra-sistema
name string Nombre
group string Grupo
disabled boolean
¿Está bloqueado el agente?

No se puede conectar con los agentes bloqueados. El bloqueo ocurre si el número de ordenadores en el plan de tarifas supera el límite.

limited boolean
¿Está limitado el agente?

El agente quedará limitado si el límite del plan de tarifas es excedido por el número de archivos adjuntos. Dentro de los 10 días siguientes a la adición, el agente limitado quedará bloqueado.

link_time unixtime Fecha y hora de la adición a la cuenta personal
last_time unixtime Fecha y hora del último estado «en la red»
geo object Geolocalización
geo.ip string Dirección IP
geo.country string País
geo.region string Región
geo.city string Ciudad
permanent_url string
URL permanente de conexión

Este campo puede no estar disponible si se restringe el acceso de usuarios no autorizados

preview_url string URL para descargar la vista previa del escritorio
os string Sistema operativo. Valores posibles: win, mac и linux
version string Versión del programa de agente
online boolean Estado actual «en la red»
installed boolean ¿Está el agente instalado en el ordenador?
favorite boolean ¿Este es el ordenador favorito de la lista en la cuenta personal?
owner string Cuenta del propietario de acceso al ordenador dentro del sistema
sessions object Información sobre las conexiones
sessions.last object Última conexión
sessions.last.id number Identificador intra-sistema de conexión
sessions.last.start_time unixtime Fecha y hora de inicio de la conexión
sessions.last.stop_time unixtime
Fecha y hora de finalización de la conexión

El campo puede no estar disponible si la conexión está activa

sessions.last.client object Información del cliente (autor de la conexión)
sessions.last.client.ip string Dirección IP
sessions.last.client.country string País
sessions.last.client.region string Región
sessions.last.client.city string Ciudad
sessions.last.client.user_agent string Agente de usuario del navegador del cliente
sessions.total object Número total de conexiones

Obtener un enlace para conectarse

Para conectarse al ordenador mediante la API es necesario obtener un enlace temporal mediante el método agents/connect

El enlace obtenido desaparece de inmediato después de su primer uso. Es necesario recibirlo cada vez que quieras conectarte.

Solicitud:

POST https://api.getscreen.me/v1/agents/connect
  ?apikey=<string>
  &agent_id=<number>
Parámetros de solicitud:
Parámetro Tipo Valor
apikey  * string API clave para autorizar la solicitud
agent_id  * number Identificador intra-sistema de agente

Respuesta:

{
    "data": 
        {
            "url": "https://go.getscreen.me/john.smith/?connect=20177&llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
        }
}
    
Datos de respuesta:
Nombre Tipo Descripción
url string URL de conexión

Lista de conexiones abiertas

Para obtener una lista de conexiones abiertas de la sección Soporte remoto utiliza el método support/list

Solicitud:

GET https://api.getscreen.me/v1/support/list
  ?apikey=<string>
Parámetros de solicitud:
Parámetro Tipo Valor
apikey  * string API clave para autorizar la solicitud

Respuesta:

{
    "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":""
        }
    ]
}
Datos de registro de conexión:
Nombre Tipo Descripción
id number Identificador intra-sistema de conexión
status number
Estado de la conexión. Valores posibles:
  • 0 - Nueva conexión, conexión pendiente del cliente
  • 1 - El cliente está conectado, se espera la conexión del operador
  • 2 - Conexión activa, todos los participantes se unieron
  • 3 - Conexión cerrada
create_time unixtime Fecha y hora de creación de la conexión
invite_code string Código de invitación
invite_url string URL de invitación
connect_url string URL para conectar al operador a la conexión
client_name string Nombre del cliente
client_os string
Sistema operativo. Valores posibles: win, mac и linux

El campo se rellena una vez que el cliente se ha unido

client_preview_url string
Miniatura de la imagen del escritorio del cliente

El campo se rellena una vez que el cliente se ha unido

Datos adicionales:
Nombre Tipo Descripción
remain number Número de conexiones restantes en el plan de tarifas

Crear una conexión

Para crear una conexión diferida para el soporte remoto, utiliza el siguiente método support/create

Solicitud:

POST https://api.getscreen.me/v1/support/create
  ?apikey=<string>
  &client_name=<string>
Parámetros de solicitud:
Parámetro Tipo Valor
apikey  * string API clave para autorizar la solicitud
client_name string Nombre del cliente (visible solo para ti). Parámetro opcional.

Respuesta:

{
    "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":""
        }
    ]
}
Únete a la conexión
Nombre Tipo Descripción
id number Identificador intra-sistema de conexión
status number
Estado de la conexión. Valores posibles:
  • 0 - Nueva conexión, conexión pendiente del cliente
  • 1 - El cliente está conectado, se espera la conexión del operador
  • 2 - Conexión activa, todos los participantes se unieron
  • 3 - Conexión cerrada
create_time unixtime Fecha y hora de creación de la conexión
invite_code string Código de invitación
invite_url string URL de invitación
connect_url string URL para conectar al operador a la conexión
client_name string Nombre del cliente
client_os string
Sistema operativo. Valores posibles: win, mac и linux

El campo se rellena una vez que el cliente se ha unido

client_preview_url string
Miniatura de la imagen del escritorio del cliente

El campo se rellena una vez que el cliente se ha unido

Información sobre la conexión

Para obtener información sobre una determinada conexión, utiliza el siguiente método support/info

Solicitud:

GET https://api.getscreen.me/v1/support/info
  ?apikey=<string>
  &connection_id=<number>
Parámetros de solicitud:
Parámetro Tipo Valor
apikey  * string API clave para autorizar la solicitud
connection_id  * number Identificador intra-sistema de conexión

Respuesta:

{
    "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"
        }
    ]
}
Datos de respuesta:
Nombre Tipo Descripción
id number Identificador intra-sistema de conexión
status number
Estado de la conexión. Valores posibles:
  • 0 - Nueva conexión, conexión pendiente del cliente
  • 1 - El cliente está conectado, se espera la conexión del operador
  • 2 - Conexión activa, todos los participantes se unieron
  • 3 - Conexión cerrada
create_time unixtime Fecha y hora de creación de la conexión
invite_code string Código de invitación
invite_url string URL de invitación
connect_url string URL para conectar al operador a la conexión
client_name string Nombre del cliente
client_os string
Sistema operativo. Valores posibles: win, mac и linux

El campo se rellena una vez que el cliente se ha unido

client_preview_url string
Miniatura de la imagen del escritorio del cliente

El campo se rellena una vez que el cliente se ha unido

Cerrar la conexión

Para cerrar la conexión, utiliza el método support/close

Solicitud:

POST https://api.getscreen.me/v1/support/close
  ?apikey=<string>
  &connection_id=<number>
Parámetros de solicitud:
Parámetro Tipo Valor
apikey  * string API clave para autorizar la solicitud
connection_id  * number Identificador intra-sistema de conexión

Respuesta:

La respuesta aparecerá con un contenido en blanco. Utiliza sólo el código de respuesta HTTP para analizar la ejecución del comando.

Obtener la lista de conexiones

Para obtener la lista de tus conexiones, utiliza el método history/list

Solicitud:

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 solicitud:
Parámetro Tipo Valor
apikey * string API clave para autorizar la solicitud
agent_id number Filtrar por ID de agente
date_from unixtime Filtrar por fecha y hora: inicio del período
date_to unixtime Filtrar por fecha y hora: fin del período
video boolean Filtrar por disponibilidad de grabación de vídeo
offset number Indentación de la primera posición en la lista
limit number Cantidad de posiciones en el lista. Por defecto, el valor es 20, el valor máximo еs 100

Respuesta:

{
   "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
         }
      },
      ...
   ]
}
                            
Datos de respuesta:
Nombre Tipo Descripción
id number Identificador intra-sistema de conexión
start unixtime Fecha y hora de inicio de la conexión
stop unixtime
Fecha y hora de finalización de la conexión

Puede estar en blanco si la conexión no se ha completado

clients array Lista de clientes que se han unido a la conexión
clients[.]user_agent string Agente de usuario
clients[.]login string
Nombre de usuario

Puede estar en blanco si la conexión fue anónima

clients[.]geo object Geolocalización
clients[.]geo.ip string Dirección IP
clients[.]geo.country string País
clients[.]geo.region string Región
clients[.]geo.city string Ciudad
agent object Información sobre el agente
agent.id number Identificador intra-sistema de agente
agent.name string Nombre
agent.group string Grupo
agent.geo object Geolocalización
agent.geo.ip string Dirección IP
agent.geo.country string País
agent.geo.region string Región
agent.geo.city string Ciudad
agent.os string Sistema operativo. Valores posibles: win, mac y linux
agent.version string Versión del programa
agent.owner string Inicia sesión de la cuenta del propietario de acceso permanente
video object
Información sobre la grabación de vídeo

Puede que no esté disponible si no hubo grabación de vídeo de la conexión

video.url string
Dirección para descargar el archivo de grabación de vídeo

Para cargar el archivo con la grabación del vídeo de la conexión es necesario añadir el parámetro ?apikey=con el valor de tu clave API.

video.size number Tamaño del archivo de grabación de vídeo en bytes

Integración individual

¿No hay recursos para la integración autónoma?
¿Se necesitan más funciones que las que ofrece la HTTP API?
Estamos listos para ofrecer el desarrollo de la integración individual desde un pequeño botón dentro de tu aplicación hasta un proveedor OEM integral de servicios de acceso remoto.

Deja una solicitud

En breve nos pondremos en contacto contigo
Enviar la solicitud
¡Se ha enviado la solicitud!
En breve nos pondremos en contacto contigo

¿Qué es lo que falta?

Si no dispones de los métodos o datos en el HTTP API, por favor envíenos un correo electrónico a info@getscreen.me o al chat del sitio web.
Consideraremos tu solicitud e intentaremos ayudarte.