HTTP API¶
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
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 |
402 Payment Required | Solicitud rechazada, se ha superado el límite de solicitud para el plan de tarifas |
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 GET ?apikey=
o en el encabezado HTTP X-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:
- Acceso permanente
- Soporte rápido
- Historial de conexiones
Acceso permanente¶
Lista de ordenadores¶
Puedes obtener la lista completa de ordenadores usando el método agents/list
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:
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? |
limited | boolean | ¿Está limitado el agente? |
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 |
onetime_url | string | URL para la conexión por una vez |
preview_url | string | URL para descargar la vista previa del escritorio |
os | string | Sistema operativo. Valores posibles: win , mac , linux y android |
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 |
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 |
Información sobre el ordenador¶
Para consultar la información sobre el ordenador de la sección Acceso permanente tienes que utilizar el método agents/info
Solicitud:
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": {
"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
}
}
}
Datos de respuesta:
Nombre | Tipo | Descripción |
---|---|---|
id | number | Identificador intra-sistema |
name | string | Nombre |
group | string | Grupo |
disabled | boolean | ¿Está bloqueado el agente? |
limited | boolean | ¿Está limitado el agente? |
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 |
onetime_url | string | URL para la conexión por una vez |
preview_url | string | URL para descargar la vista previa del escritorio |
os | string | Sistema operativo. Valores posibles: win , mac , linux y android |
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 |
hardware | object | Información sobre el sistema |
hardware.BIOS | string | Información del BIOS |
hardware.BIOSDate | string | Fecha de actualización |
hardware.BIOSVersion | string | Versión |
hardware.CPU | string | Procesador |
hardware.CPUCores | number | Número de núcleos |
hardware.CPUCoresLogical | number | Número de procesadores lógicos |
hardware.CPUFamily | string | Familia |
hardware.CPUSpeed | number | Velocidad |
hardware.ComputerDomain | string | Dominio |
hardware.ComputerIP | array | Dirección IP |
hardware.ComputerModel | string | Modelo |
hardware.ComputerName | string | Nombre del ordenador |
hardware.ComputerWorkgroup | string | Grupo de trabajo |
hardware.HDD | array | Discos duros |
hardware.HDD[].Model | string | Modelo |
hardware.HDD[].Size | number | Tamaño |
hardware.Locale | string | Configuración regional |
hardware.LocaleCountry | string | País |
hardware.LocaleCurrency | string | Divisa |
hardware.LocaleFormatDate | string | Formato de fecha |
hardware.LocaleFormatTime | string | Formato de la hora |
hardware.LocaleOemPage | string | Codificación de páginas |
hardware.LocaleTimezone | number | Huso horario |
hardware.LogicalDisks | array | Discos lógicos |
hardware.LogicalDisks[].Disk | string | Etiqueta |
hardware.LogicalDisks[].FileSystem | string | Tipo de sistema de archivo |
hardware.LogicalDisks[].FreeSpace | number | Espacio libre (MB) |
hardware.LogicalDisks[].Name | string | Nombre |
hardware.LogicalDisks[].Size | number | Tamaño (MB) |
hardware.Monitors | array | Monitores |
hardware.Monitors[].Name | string | Nombre |
hardware.Monitors[].ScreenHeight | number | Altura de pantalla |
hardware.Monitors[].ScreenWidth | number | Ancho de pantalla |
hardware.NetAdapters | array | Tarjetas de red |
hardware.NetAdapters[].Addresses | string | Dirección |
hardware.NetAdapters[].Cable | boolean | Conexión a Internet mediante cable LAN |
hardware.NetAdapters[].DCHP | string | DCHP |
hardware.NetAdapters[].DNS | string | DNS |
hardware.NetAdapters[].MACAddress | string | Dirección MAC |
hardware.NetAdapters[].Manufacturer | string | Fabricante |
hardware.NetAdapters[].Name | string | Nombre |
hardware.NetAdapters[].Speed | number | Velocidad |
hardware.NetAdapters[].WoL | boolean | Configuración de Wake-on-LAN activada |
hardware.OSName | string | Nombre del sistema operativo |
hardware.OSVersion | string | Versión del sistema operativo |
hardware.RAMBanks | array | Memoria RAM |
hardware.RAMBanks[].Bank | string | Slot |
hardware.RAMBanks[].Capacity | number | Capacidad |
hardware.RAMBanks[].Locator | string | Localizador |
hardware.RAMBanks[].Manufacturer | string | Fabricante |
hardware.RAMBanks[].PartNumber | string | Lote |
hardware.RAMBanks[].SerialNumber | string | Serie |
hardware.SoundDevices | array | Tarjetas de sonido |
hardware.SoundDevices[].Name | string | Nombre |
hardware.VideoCards | array | Tarjeta de vídeo |
hardware.VideoCards[].Integrated | boolean | Integrada |
hardware.VideoCards[].Name | string | Nombre |
hardware.VideoCards[].RAM | number | Memoria |
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 |
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:
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 |
Soporte rápido¶
Lista de conexiones abiertas¶
Para obtener una lista de conexiones abiertas de la sección Soporte remoto utiliza el método support/list
Solicitud:
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":""
} ]
}
Nombre | Tipo | Descripción |
---|---|---|
id | number | Identificador intra-sistema de conexión |
status | number | Estado de la conexión. Valores posibles:
|
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 y android |
client_preview_url | string | Miniatura de la imagen del escritorio del cliente |
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:
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":""
}
}
Datos de respuesta:
Nombre | Tipo | Descripción |
---|---|---|
id | number | Identificador intra-sistema de conexión |
status | number | Estado de la conexión. Valores posibles:
|
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 y android |
client_preview_url | string | Miniatura de la imagen del escritorio del cliente |
Información sobre la conexión¶
Para obtener información sobre una determinada conexión, utiliza el siguiente método support/info
Solicitud:
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://getscreen.me/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:
|
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 y android |
client_preview_url | string | Miniatura de la imagen del escritorio del cliente |
Cerrar la conexión¶
Para cerrar la conexión, utiliza el método support/close
Solicitud:
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.
Historial de conexiones¶
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>
&support_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 | string | Filtrar por ID de agente |
support_id | number | Filtro por identificador de conexión de Soporte rápido |
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,
"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
}
}, ... ]
}
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 |
support_id | number | Identificador de conexión de Soporte rápido |
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 |
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 , linux y android |
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 |
video.url | string | Dirección para descargar el archivo de grabación de vídeo?apikey= con el valor de tu clave API. |
video.size | number | Tamaño del archivo de grabación de vídeo en bytes |
Última actualización: 15 de mayo de 2023