La API HTTP 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
Métodos
These are commands for managing computers and connections. We have divided them into several groups:
- Acceso permanente
- Soporte a distancia
- Connection history
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:
|
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:
|
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:
|
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.
Get connection list
Use the history/list method to get a list of your connections.
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 | Filter by agent ID |
date_from | unixtime | Filter by date and time - beginning of period |
date_to | unixtime | Filter by date and time - end of period |
video | boolean | Filter by video availability |
offset | number | Offset of the first position in the list |
limit | number | The number of items in the list. The default value is 20, the maximum value is 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 | Intra-system connection identifier |
start | unixtime | Connection start date and time |
stop | unixtime |
End date and time of the connection
Can be empty if the connection is not completed |
clients | array | List of clients who joined the connection |
clients[.]user_agent | string | User-Agent |
clients[.]login | string |
User login
Can be empty if the connection was anonymous |
clients[.]geo | object | Geo-location |
clients[.]geo.ip | string | IP address |
clients[.]geo.country | string | Country |
clients[.]geo.region | string | Region |
clients[.]geo.city | string | City |
agent | object | Agent Information |
agent.id | number | Intra-system agent identifier |
agent.name | string | Title |
agent.group | string | Group |
agent.geo | object | Geo-location |
agent.geo.ip | string | IP address |
agent.geo.country | string | Country |
agent.geo.region | string | Region |
agent.geo.city | string | City |
agent.os | string | Operating system. Possible values: win, mac and linux. |
agent.version | string | Program version |
agent.owner | string | Login to the account of the owner of the permanent access |
video | object |
Video recording information
May not be present if there was no video recording of the connection |
video.url | string |
Address for downloading the video file of the recording
To download the video file of the connection record, you must add the parameter ?apikey= with the value of your API key. |
video.size | number | Record video file size in bytes |