HTTP API - Getscreen.me

HTTP API ermöglicht es Ihnen einen Programmzugriff zu den meisten in Ihrem persönlichen Konto verfügbaren Funktionen zu erhalten: Computer verwalten, ausstehende Verbindungen erstellen.

Anfragen

Alle Anfragen müssen nach HTTPS Protokoll (nicht HTTP) mit der entsprechenden Methode für jeden Befehl unter https://api.getscreen.me/v1/">https://api.getscreen.me/v1/ ausgeführt werden

Antworten

Antworten mit Daten werden im JSON-Format in UTF-8-Codierung mit ContentType: application/json zurückgegeben. In jeder Antwort werden die Daten in einen JSON-Container verpackt data

Antwortcodes:

Der API-Server kann die folgenden HTTP-Antwortcodes zurückgeben:

HTTP-Antwortcode	Beschreibung
200 OK	Anfrage angenommen und bearbeitet
400 Bad Request	Anfrage abgelehnt, ungültige Parameter, Fehler
402 Payment Required	Request rejected, request limit for the service plan exceeded
403 Forbidden	Anfrage abgelehnt, kein Zugriff auf Daten
404 Not Found	Anfrage abgelehnt, unbekannter URL-Request

Authentifizierung

Die API ist eine RESTful-API – der Server speichert den Status der Kundenverbindung nicht. Daher muss der Kunde bei jeder Anfrage Autorisierungsdaten senden. Für solche Daten wird ein API-Schlüssel verwendet. Fügen Sie den Schlüssel in jeder Anfrage im Parameter hinzu ?apikey=

https://api.getscreen.me/v1/?apikey=YOUR_API_KEY

Ihr API-Schlüssel befindet sich im Benutzerkonto unter "Integration" in der Registerkarte HTTP API

Methoden

Dies sind Befehle zum Verwalten von Computern und Verbindungen. Wir haben sie in mehrere Gruppen eingeteilt:

Dauerhafter Zugriff
- Liste der Computer
- Link zum Verbinden erhalten
Schneller Support
Verbindungsverlauf
- Verbindungsliste erhalten

Liste der Computer

Sie können eine vollständige Liste der Computer mit der Methode devices/agents abrufen

Im Zusammenhang mit API-Aufrufen werden Computer als "Agenten" bezeichnet, da der Computer im technischen Sinn durch das Agentenprogramm gesteuert wird

Anfrage:

GET https://api.getscreen.me/v1/agents/list
  ?apikey=<string>

Parameter der Anfrage:

Parameter	Typ	Wert
apikey *	string	API-Schlüssel zum Autorisieren der Anfrage

Antwort:

{
    "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
            }
        },
        ...
    ]
}

Antwortdaten:

Bezeichnung	Typ	Beschreibung
id	number	Systeminterne Kennung
name	string	Bezeichnung
group	string	Gruppe
disabled	boolean	Agent blockiert? Eine Verbindung zu blockierten Agenten ist nicht möglich. Die Sperrung erfolgt bei Überschreitung der Computeranzahl des Abonnements.
limited	boolean	Ist der Agent beschränkt? Der Software-Agent wird beschränkt, wenn die Grenze des Abonnements für die Anzahl der angehängten Dateien überschritten wird. 10 Tage nach dem Hinzufügen wird der eingeschränkte Agent gesperrt.
link_time	unixtime	Hinzufügungsdatum und Uhrzeit zu Ihrem Benutzerkonto
last_time	unixtime	Datum und Uhrzeit des zuletzt "Online" Status
geo	object	Standort
geo.ip	string	IP-Adresse
geo.country	string	Land
geo.region	string	Region
geo.city	string	Stadt
permanent_url	string	Dauerhafte Verbindungs-URL Das Feld kann fehlen, wenn unbefugten Benutzern der Zugriff verweigert wird
preview_url	string	URL zum Herunterladen der Desktop-Vorschau
os	string	Betriebssystem. Mögliche Werte: win, mac, linux und android
version	string	Programmversion des Agenten
online	boolean	Aktueller Status «Online»
installed	boolean	Ist der Software-Agent auf dem Computer installiert?
favorite	boolean	Ist dieser Computer ein Favorit in der Liste in Ihrem Benutzerkonto?
owner	string	Benutzerkonto des Inhabers des Zugriffs auf den Computer innerhalb des Systems
sessions	object	Information zu den Verbindungen
sessions.last	object	Letzte Verbindung
sessions.last.id	number	Systeminterne Kennung der Verbindung
sessions.last.start_time	unixtime	Datum und Uhrzeit des Verbindungsbeginns
sessions.last.stop_time	unixtime	Datum und Uhrzeit des Verbindungsendes Das Feld kann fehlen, wenn die Verbindung aktiv ist
sessions.last.client	object	Kundeninformationen (Ersteller der Verbindung)
sessions.last.client.ip	string	IP-Adresse
sessions.last.client.country	string	Land
sessions.last.client.region	string	Region
sessions.last.client.city	string	Stadt
sessions.last.client.user_agent	string	User Agent des Kunden-Browsers
sessions.total	object	Gesamtanzahl an Verbindungen

Link zum Verbinden erhalten

Um eine Verbindung zu einem Computer über die API herzustellen, müssen Sie einen einmaligen Link mithilfe der Methode agents/connect generieren

Der erhaltene Link ist verfällt sofort nach der ersten Anwendung. Sie müssen für jeden Anschluss einen neuen Link generieren.

Anfrage:

POST https://api.getscreen.me/v1/agents/connect
  ?apikey=<string>
  &agent_id=<number>

Parameter der Anfrage:

Parameter	Typ	Wert
apikey *	string	API-Schlüssel zum Autorisieren der Anfrage
agent_id *	number	Systeminterne Kennung des Agenten

Antwort:

{
    "data": 
        {
            "url": "https://go.getscreen.me/john.smith/?connect=20177&llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
        }
}

Antwortdaten:

Bezeichnung	Typ	Beschreibung
url	string	URL zum Verbinden

Liste der offenen Verbindungen

Um eine Liste der offenen Verbindungen aus dem Abschnitt Schneller Support zu erhalten, verwenden Sie die Methode support/list

Anfrage:

GET https://api.getscreen.me/v1/support/list
  ?apikey=<string>

Parameter der Anfrage:

Parameter	Typ	Wert
apikey *	string	API-Schlüssel zum Autorisieren der Anfrage

Antwort:

{
    "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":""
        }
    ]
}

Verbindungsdatensatz:

Bezeichnung	Typ	Beschreibung
id	number	Systeminterne Kennung der Verbindung
status	number	Verbindungsstatus. Mögliche Bedeutung: 0 - Neue Verbindung, warte auf Anschluss des Kunden 1 - Kunde ist verbunden, warte auf Anschluss des Nutzers 2 - Aktive Verbindung, alle Teilnehmer sind beigetreten 3 - Geschlossene Verbindung
create_time	unixtime	Datum und Uhrzeit des Verbindungsaufbaus
invite_code	string	Einladungscode
invite_url	string	URL zum Einladen
connect_url	string	URL zum Beitreteten des Nutzers zur Verbindung
client_name	string	Kundenname
client_os	string	Betriebssystem. Mögliche Werte: win, mac, linux und android Das Feld wird nach dem Anschluss des Kunden gefüllt
client_preview_url	string	Miniaturansicht des Kunden-Desktops Das Feld wird nach dem Anschluss des Kunden gefüllt

Zusätzliche Information:

Bezeichnung	Typ	Beschreibung
remain	number	Anzahl der verbleibenden Verbindungen innerhalb Ihres Abos

Verbindung herstellen

Um eine zeitverzögerte Verbindung für den Remote Support zu erstellen verwenden Sie die Methode support/create

Anfrage:

POST https://api.getscreen.me/v1/support/create
  ?apikey=<string>
  &client_name=<string>

Parameter der Anfrage:

Parameter	Typ	Wert
apikey *	string	API-Schlüssel zum Autorisieren der Anfrage
client_name	string	Kundenname (dieser ist nur für Sie sichtbar). Optionaler Parameter.

Antwort:

{
    "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":""
        }
    ]
}

An der Sitzung teilnehmen

Bezeichnung	Typ	Beschreibung
id	number	Systeminterne Kennung der Verbindung
status	number	Verbindungsstatus. Mögliche Bedeutung: 0 - Neue Verbindung, warte auf Anschluss des Kunden 1 - Kunde ist verbunden, warte auf Anschluss des Nutzers 2 - Aktive Verbindung, alle Teilnehmer sind beigetreten 3 - Geschlossene Verbindung
create_time	unixtime	Datum und Uhrzeit des Verbindungsaufbaus
invite_code	string	Einladungscode
invite_url	string	URL zum Einladen
connect_url	string	URL zum Beitreteten des Nutzers zur Verbindung
client_name	string	Kundenname
client_os	string	Betriebssystem. Mögliche Werte: win, mac, linux und android Das Feld wird nach dem Anschluss des Kunden gefüllt
client_preview_url	string	Miniaturansicht des Kunden-Desktops Das Feld wird nach dem Anschluss des Kunden gefüllt

Information zur Verbindung

Um Information zu einer konkreten Verbindung zu erhalten, verwenden Sie die Methode support/info

Anfrage:

GET https://api.getscreen.me/v1/support/info
  ?apikey=<string>
  &connection_id=<number>

Parameter der Anfrage:

Parameter	Typ	Wert
apikey *	string	API-Schlüssel zum Autorisieren der Anfrage
connection_id *	number	Systeminterne Kennung der Verbindung

Antwort:

{
    "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"
        }
    ]
}

Antwortdaten:

Bezeichnung	Typ	Beschreibung
id	number	Systeminterne Kennung der Verbindung
status	number	Verbindungsstatus. Mögliche Bedeutung: 0 - Neue Verbindung, warte auf Anschluss des Kunden 1 - Kunde ist verbunden, warte auf Anschluss des Nutzers 2 - Aktive Verbindung, alle Teilnehmer sind beigetreten 3 - Geschlossene Verbindung
create_time	unixtime	Datum und Uhrzeit des Verbindungsaufbaus
invite_code	string	Einladungscode
invite_url	string	URL zum Einladen
connect_url	string	URL zum Beitreteten des Nutzers zur Verbindung
client_name	string	Kundenname
client_os	string	Betriebssystem. Mögliche Werte: win, mac, linux und android Das Feld wird nach dem Anschluss des Kunden gefüllt
client_preview_url	string	Miniaturansicht des Kunden-Desktops Das Feld wird nach dem Anschluss des Kunden gefüllt

Verbindung schließen

Um die Verbindung zu schließen, verwenden Sie die Methode support/close

Anfrage:

POST https://api.getscreen.me/v1/support/close
  ?apikey=<string>
  &connection_id=<number>

Parameter der Anfrage:

Parameter	Typ	Wert
apikey *	string	API-Schlüssel zum Autorisieren der Anfrage
connection_id *	number	Systeminterne Kennung der Verbindung

Antwort:

Die Antwort wird mit leerem Inhalt ankommen. Verwenden Sie zum Analysieren der Befehlsausführung nur den HTTP-Antwortcode.

Verbindungsliste erhalten

Um eine Liste aller Ihrer Verbindungen zu erhalten, verwenden Sie die Methode history/list

Anfrage:

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>

Parameter der Anfrage:

Parameter	Typ	Wert
apikey *	string	API-Schlüssel zum Autorisieren der Anfrage
agent_id	number	Nach Agenten-ID filtern
date_from	unixtime	Nach Datum und Uhrzeit filtern - Beginn der Periode
date_to	unixtime	Nach Datum und Uhrzeit filtern - Ende der Periode
video	boolean	Nach vorhandener Videoaufzeichnung filtern
offset	number	Die erste Position in der Liste einrücken
limit	number	Anzahl der Elemente in der Liste. Standardmäßig - 20, Maximalwert - 100

Antwort:

{
   "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
         }
      },
      ...
   ]
}

Antwortdaten:

Bezeichnung	Typ	Beschreibung
id	number	Systeminterne Kennung der Verbindung
start	unixtime	Datum und Uhrzeit des Verbindungsbeginns
stop	unixtime	Datum und Uhrzeit des Verbindungsendes Darf leer sein, wenn die Verbindung noch nicht beendet ist
clients	array	Liste der Kunden, die der Sitzung beigetreten sind
clients[.]user_agent	string	User Agent
clients[.]login	string	Benutzeranmeldung Darf leer sein, wenn die Verbindung anonym war
clients[.]geo	object	Standort
clients[.]geo.ip	string	IP-Adresse
clients[.]geo.country	string	Land
clients[.]geo.region	string	Region
clients[.]geo.city	string	Stadt
agent	object	Information zum Agenten
agent.id	number	Systeminterne Kennung des Agenten
agent.name	string	Bezeichnung
agent.group	string	Gruppe
agent.geo	object	Standort
agent.geo.ip	string	IP-Adresse
agent.geo.country	string	Land
agent.geo.region	string	Region
agent.geo.city	string	Stadt
agent.os	string	Betriebssystem. Mögliche Werte: win, mac, android und linux
agent.version	string	Programmversion
agent.owner	string	Login des Kontos des Benutzers des dauerhaften Zugriffs
video	object	Information zur Videoaufzeichnung Kann fehlen, wenn es keine Videoaufzeichnung der Sitzung gab
video.url	string	Adresse zum Hochladen der Videoaufzeichnung Um eine Videodatei der Sitzung hochzuladen müssen Sie den Parameter ?apikey= mit dem Wert Ihres API-Schlüssels angeben.
video.size	number	Größe der Videoaufzeichnung in Byte

Integration mithilfe der HTTP API

Anfragen

Antworten

Antwortcodes:

Authentifizierung

Methoden

Liste der Computer

Anfrage:

Parameter der Anfrage:

Antwort:

Antwortdaten:

Link zum Verbinden erhalten

Anfrage:

Parameter der Anfrage:

Antwort:

Antwortdaten:

Liste der offenen Verbindungen

Anfrage:

Parameter der Anfrage:

Antwort:

Verbindungsdatensatz:

Zusätzliche Information:

Verbindung herstellen

Anfrage:

Parameter der Anfrage:

Antwort:

An der Sitzung teilnehmen

Information zur Verbindung

Anfrage:

Parameter der Anfrage:

Antwort:

Antwortdaten:

Verbindung schließen

Anfrage:

Parameter der Anfrage:

Antwort:

Verbindungsliste erhalten

Anfrage:

Parameter der Anfrage:

Antwort:

Antwortdaten:

Individuelle Integrationen

Anfrage hinterlassen

Etwas fehlt?