Plugins HTTP API Agent SDK
Commander une intégration

Intégration à l'aide de HTTP API

Créez des intégrations uniques avec vos plateformes.
Simplifiez votre connexion jusqu'à quelques clics.

HTTP API vous permet d'accéder à la plupart des fonctions disponibles dans votre espace client : gestion des ordinateurs, création de connexions en attente.

Demandes

Toutes les demandes doivent être effectuées via HTTPS (et non HTTP) avec la méthode appropriée pour chaque commande à https://api.getscreen.me/v1/

Réponses

Les réponses avec les données sont renvoyées au format JSON et encodées en UTF-8 depuis ContentType: application/json . Dans chaque réponse, les données sont encapsulées dans un conteneur JSON data

Codes de réponse :

Le serveur API peut renvoyer les codes de réponse HTTP suivants :

Code de réponse HTTP Description
200 OK Demande acceptée et traitée
400 Bad Request Demande refusée, paramètres non valides, erreur
403 Forbidden Demande refusée, pas d'accès aux données
404 Not Found Demande refusée, URL de demande inconnue

Authentification

L'API est une API RESTful — le serveur ne stocke pas l'état de la connexion client. Par conséquent, chaque fois qu'une demande est envoyée, le client doit envoyer ses données d'autorisation. Une clé API est utilisée comme ces données. Ajoutez la clé dans chaque demande dans le paramètre ?apikey=

https://api.getscreen.me/v1/?apikey=YOUR_API_KEY
Votre clé API se trouve dans votre armoire personnelle dans la section "Intégration" de l'onglet HTTP API

Méthodes

Ce sont des commandes de gestion des ordinateurs et des connexions. Nous les avons divisés en plusieurs groupes :


Liste des ordinateurs

Vous pouvez obtenir une liste complète des ordinateurs en utilisant la méthode devices/agents

Dans le contexte des appels d'API, les ordinateurs seront appelés «Agents», car techniquement un ordinateur est contrôlé via le programme d'agent

Demande :

GET https://api.getscreen.me/v1/agents/list
  ?apikey=<string>
Paramètres de la demande :
Paramètre Type Valeur
apikey  * string Clé API pour l'autorisation de demande

Réponse :

{
    "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
            }
        },
        ...
    ]
}
Données de réponse :
Nom Type Description
id number Identifiant intra-système
name string Nom
group string Groupe
disabled boolean
L'agent est-il bloqué ?

Vous ne pouvez pas vous connecter aux agents bloqués. L'agent est bloqué en cas de dépassement de la limite du nombre d'ordinateurs dans le plan tarifaire.

limited boolean
L'agent est-il limité ?

L'agent est limité si la limite du plan tarifaire pour le nombre de fichiers joints est dépassée. 10 jours après avoir été ajouté, l'agent limité est bloqué.

link_time unixtime Date et heure de l'ajout à espace client
last_time unixtime Date et heure du dernier état en ligne
geo object Géolocalisation
geo.ip string Adresse IP
geo.country string Pays
geo.region string Région
geo.city string Ville
permanent_url string
URL de connexion permanente

Le champ peut être absent si l'accès pour les utilisateurs non autorisés est fermé

preview_url string URL pour télécharger l'aperçu de l'écran d'accueil
os string Système d'exploitation. Valeurs possibles : win, mac et linux
version string Version du programme d'agent
online boolean Statut actuel «En ligne»
installed boolean L'agent est-il installé sur l'ordinateur ?
favorite boolean S'agit-il d'un ordinateur sélectionné dans la liste de votreespace client ?
owner string Compte de propriétaire d'accès à l'ordinateur dans le système
sessions object Informations sur les connexions
sessions.last object Dernière connexion
sessions.last.id number Identifiant de connexion intra-système
sessions.last.start_time unixtime Date et heure de début de connexion
sessions.last.stop_time unixtime
Date et heure de fin de connexion

Le champ peut être absent si la connexion est active

sessions.last.client object Informations sur le client (auteur de la connexion)
sessions.last.client.ip string Adresse IP
sessions.last.client.country string Pays
sessions.last.client.region string Région
sessions.last.client.city string Ville
sessions.last.client.user_agent string Agent utilisateur du navigateur du client
sessions.total object Nombre total de connexions

Obtenir un lien pour se connecter

Pour vous connecter à un ordinateur via l'API, vous devez obtenir un lien unique en utilisant la méthode agents/connect

Le lien obtenu expire immédiatement après la première utilisation. Vous devez l'obtenir à chaque fois que vous souhaitez vous connecter.

Demande :

POST https://api.getscreen.me/v1/agents/connect
  ?apikey=<string>
  &agent_id=<number>
Paramètres de la demande :
Paramètre Type Valeur
apikey  * string Clé API pour l'autorisation de demande
agent_id  * number Identifiant d'agent intra-système

Réponse :

{
    "data": 
        {
            "url": "https://go.getscreen.me/john.smith/?connect=20177&llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
        }
}
    
Données de réponse :
Nom Type Description
url string URL de connexion

Liste des connexions ouvertes

Pour obtenir une liste des connexions ouvertes à partir de la section Soutien rapide, utilisez la méthode support/list

Demande :

GET https://api.getscreen.me/v1/support/list
  ?apikey=<string>
Paramètres de la demande :
Paramètre Type Valeur
apikey  * string Clé API pour l'autorisation de demande

Réponse :

{
    "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":""
        }
    ]
}
Données d'enregistrement de connexion :
Nom Type Description
id number Identifiant de connexion intra-système
status number
État de la connexion. Valeurs possibles :
  • 0 - Nouvelle connexion, connexion du client en attente
  • 1 - Client connecté, connexion de l'opérateur en attente
  • 2 - Connexion active, tous les participants sont connectés
  • 3 - Connexion fermée
create_time unixtime Date et heure de création de la connexion
invite_code string Code d'invitation
invite_url string URL d'invitation
connect_url string URL pour connecter l'opérateur à la connexion
client_name string Nom du client
client_os string
Système d'exploitation. Valeurs possibles : win, mac et linux

Le champ est rempli après la connexion du client

client_preview_url string
Vignette de l'écran d'accueil du client

Le champ est rempli après la connexion du client

Informations complémentaires :
Nom Type Description
remain number Nombre de connexions restantes dans le plan tarifaire

Créer une connexion

Pour créer une connexion en attente pour l'soutien rapide, utilisez la méthode support/create

Demande :

POST https://api.getscreen.me/v1/support/create
  ?apikey=<string>
  &client_name=<string>
Paramètres de la demande :
Paramètre Type Valeur
apikey  * string Clé API pour l'autorisation de demande
client_name string Nom du client (visible uniquement par vous). Paramètre facultatif.

Réponse :

{
    "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":""
        }
    ]
}
Participez à la connexion
Nom Type Description
id number Identifiant de connexion intra-système
status number
État de la connexion. Valeurs possibles :
  • 0 - Nouvelle connexion, connexion du client en attente
  • 1 - Client connecté, connexion de l'opérateur en attente
  • 2 - Connexion active, tous les participants sont connectés
  • 3 - Connexion fermée
create_time unixtime Date et heure de création de la connexion
invite_code string Code d'invitation
invite_url string URL d'invitation
connect_url string URL pour connecter l'opérateur à la connexion
client_name string Nom du client
client_os string
Système d'exploitation. Valeurs possibles : win, mac et linux

Le champ est rempli après la connexion du client

client_preview_url string
Vignette de l'écran d'accueil du client

Le champ est rempli après la connexion du client

Informations sur la connexion

Pour obtenir des informations sur une connexion spécifique, utilisez la méthode support/info

Demande :

GET https://api.getscreen.me/v1/support/info
  ?apikey=<string>
  &connection_id=<number>
Paramètres de la demande :
Paramètre Type Valeur
apikey  * string Clé API pour l'autorisation de demande
connection_id  * number Identifiant de connexion intra-système

Réponse :

{
    "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"
        }
    ]
}
Données de réponse :
Nom Type Description
id number Identifiant de connexion intra-système
status number
État de la connexion. Valeurs possibles :
  • 0 - Nouvelle connexion, connexion du client en attente
  • 1 - Client connecté, connexion de l'opérateur en attente
  • 2 - Connexion active, tous les participants sont connectés
  • 3 - Connexion fermée
create_time unixtime Date et heure de création de la connexion
invite_code string Code d'invitation
invite_url string URL d'invitation
connect_url string URL pour connecter l'opérateur à la connexion
client_name string Nom du client
client_os string
Système d'exploitation. Valeurs possibles : win, mac et linux

Le champ est rempli après la connexion du client

client_preview_url string
Vignette de l'écran d'accueil du client

Le champ est rempli après la connexion du client

Fermer la connexion

Pour fermer la connexion, utilisez la méthode support/close

Demande :

POST https://api.getscreen.me/v1/support/close
  ?apikey=<string>
  &connection_id=<number>
Paramètres de la demande :
Paramètre Type Valeur
apikey  * string Clé API pour l'autorisation de demande
connection_id  * number Identifiant de connexion intra-système

Réponse :

La réponse viendra avec un contenu vide. Utilisez uniquement le code de réponse HTTP pour analyser l'exécution de la commande.

Obtenir une liste de connexions

Pour obtenir une liste de vos connexions, utilisez la méthode history/list

Demande :

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>
Paramètres de la demande :
Paramètre Type Valeur
apikey * string Clé API pour l'autorisation de demande
agent_id number Filtrer par ID d'agent
date_from unixtime Filtrer par date et heure — début de période
date_to unixtime Filtrer par date et heure — fin de période
video boolean Filtrer par la présence d'un enregistrement vidéo
offset number Mettre en retrait la première position de la liste
limit number Le nombre d'éléments dans la liste. Par défaut — 20, valeur maximale — 100

Réponse :

{
   "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
         }
      },
      ...
   ]
}
                            
Données de réponse :
Nom Type Description
id number Identifiant de connexion interne
start unixtime Date et heure de début de la connexion
stop unixtime
Date et heure de fin de la connexion

Peut être vide si la connexion n'est pas terminée

clients array Liste des clients qui ont rejoint la connexion
clients[.]user_agent string Agent utilisateur
clients[.]login string
Enregistrement de l'utilisateur

Peut être vide si la connexion était anonyme

clients[.]geo object Géolocalisation
clients[.]geo.ip string Adresse IP
clients[.]geo.country string Pays
clients[.]geo.region string Région
clients[.]geo.city string Ville
agent object Informations sur l'agent
agent.id number Identifiant d'agent interne
agent.name string Nom
agent.group string Groupe
agent.geo object Géolocalisation
agent.geo.ip string Adresse IP
agent.geo.country string Pays
agent.geo.region string Région
agent.geo.city string Ville
agent.os string Système d'exploitation. Valeurs possibles : win, mac и linux
agent.version string Version du programme
agent.owner string Login du compte propriétaire d'un accès permanent
video object
Informations sur l'enregistrement vidéo

Peuvent être absentes s'il n'y avait pas d'enregistrement vidéo

video.url string
Adresse de chargement du fichier d'enregistrement vidéo

Pour charger le fichier vidéo de l'enregistrement de connexion, il faut ajouter un paramètre ?apikey= avec la valeur de votre clé API.

video.size number Taille du fichier vidéo d'enregistrement en octets

Intégration individuelle

Pas de ressources pour l'intégration personnelle ?
Besoin de plus de fonctionnalités que les offres HTTP API ?
Nous sommes prêts à proposer le développement de l'intégration individuelle d'un petit bouton dans votre application à un fournisseur OEM à part entière de services d'accès à distance.

Laisser une demande

Nous vous contacterons sous peu
Envoyer une demande
La demande a été envoyée !
Nous vous contacterons sous peu

Quelque chose manque ?

S'il vous manque des méthodes ou des données dans HTTP API, écrivez-nous à info@getscreen.me ou dans le chat sur le site Web.
Nous examinerons votre demande et essayerons de vous aider.