HerunterladenDie HTTP-API ermöglicht Ihnen den programmatischen Zugriff auf die meisten in Ihrem persönlichen Konto verfügbaren Funktionen: Computer verwalten, ausstehende Verbindungen erstellen.
Anfragen
Alle Anfragen müssen über HTTPS (nicht HTTP) unter Verwendung der entsprechenden Methode für jeden Befehl unter https://api.getscreen.me/v1/ erfolgen
Antworten
Datenantworten 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 |
| 403 Forbidden | Anfrage abgelehnt, kein Zugriff auf Daten |
| 404 Not Found | Anfrage abgelehnt, unbekannte Anfrage-URL |
Authentifizierung
Die API ist eine RESTful-API – der Server speichert den Status der Client-Verbindung nicht. Daher muss der Client jedes Mal, wenn eine Anfrage gesendet wird, Autorisierungsdaten senden. Als solche Daten wird ein API-Schlüssel verwendet. Fügen Sie den Schlüssel in jeder Anfrage in Parameter ?apikey=
https://api.getscreen.me/v1/?apikey=YOUR_API_KEY
Methoden
Dies sind Befehle zum Verwalten von Computern und Verbindungen. Wir haben sie in mehrere Gruppen eingeteilt:
- Permanenter Zugriff
- Schnelle Unterstützung
- Verbindungsverlauf
Liste der Computer
Eine vollständige Liste der Computer erhalten Sie mit der Methode devices/agents
Im Zusammenhang mit API-Aufrufen werden Computer als "Agenten" bezeichnet, da der Computer technisch durch das Agentenprogramm gesteuert wird
Anfrage:
GET https://api.getscreen.me/v1/agents/list ?apikey=<string>
Anfrageparameter:
| Parameter | Eine Art | Wert |
|---|---|---|
| apikey * | string | API-Schlüssel zur Autorisierung der Anfrage |
Antworten:
{
"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:
| Name | Eine Art | Beschreibung |
|---|---|---|
| id | number | Systeminterne Kennung |
| name | string | Name |
| group | string | Gruppe |
| disabled | boolean |
Ist der Agent gesperrt?
Sie können keine Verbindung zu blockierten Agenten herstellen. Die Sperrung erfolgt bei Überschreitung der Rechneranzahl im Tarifplan. |
| limited | boolean |
Ist der Agent beschränkt?
Der Vermittler wird beschränkt, wenn die Grenze des Tarifplans für die Anzahl der Anlagen überschritten wird. 10 Tage nach dem Hinzufügen wird der limitierte Agent gesperrt. |
| link_time | unixtime | Datum und Uhrzeit des Hinzufügens zu Ihrem persönlichen Konto |
| last_time | unixtime | Datum und Uhrzeit des letzten Online-Zustands |
| geo | object | Geo-Standort |
| geo.ip | string | IP Adresse |
| geo.country | string | Land |
| geo.region | string | Region |
| geo.city | string | Stadt |
| permanent_url | string |
Permanente Verbindungs-URL
Das Feld kann fehlen, wenn der Zugang für nicht autorisierte Benutzer gesperrt ist |
| preview_url | string | URL zum Herunterladen der Desktop-Vorschau |
| os | string | Operationssystem. Mögliche Werte: win, mac, linux und android |
| version | string | Version des Agentenprogramms |
| online | boolean | Aktueller Status "Online" |
| installed | boolean | Ist der Agent auf dem Computer installiert? |
| favorite | boolean | Ist dies ein ausgewählter Computer in der Liste Ihres persönlichen Kontos? |
| owner | string | Das Konto des Inhabers des Zugriffs auf den Computer innerhalb des Systems |
| sessions | object | Verbindungsinformationen |
| sessions.last | object | Letzte Verbindung |
| sessions.last.id | number | Systeminterne Verbindungs-ID |
| sessions.last.start_time | unixtime | Startdatum und -uhrzeit der Verbindung |
| sessions.last.stop_time | unixtime |
Datum und Uhrzeit des Verbindungsendes
Das Feld kann fehlen, wenn die Verbindung aktiv ist |
| sessions.last.client | object | Client-Informationen (Verbindungsautor) |
| 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 | Client-Browser-Benutzeragent |
| sessions.total | object | Gesamtzahl der Verbindungen |
Holen Sie sich einen Link zum Verbinden
Um sich über eine API mit einem Computer zu verbinden, müssen Sie einen einmaligen Link mit der Methode agents/connect erhalten
Der resultierende Link verfällt sofort nach der ersten Nutzung. Sie müssen es jedes Mal abrufen, wenn Sie eine Verbindung herstellen möchten.
Anfrage:
POST https://api.getscreen.me/v1/agents/connect ?apikey=<string> &agent_id=<number>
Anfrageparameter:
| Parameter | Eine Art | Wert |
|---|---|---|
| apikey * | string | API-Schlüssel zur Autorisierung der Anfrage |
| agent_id * | number | Systeminterne Agentenkennung |
Antworten:
{
"data":
{
"url": "https://go.getscreen.me/john.smith/?connect=20177&llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
}
}
Antwortdaten:
| Name | Eine Art | Beschreibung |
|---|---|---|
| url | string | Verbindungs-URL |
Liste der offenen Verbindungen
Um eine Liste der offenen Verbindungen aus Abschnitt Quick support zu erhalten, verwenden Sie Methode support/list
Anfrage:
GET https://api.getscreen.me/v1/support/list ?apikey=<string>
Anfrageparameter:
| Parameter | Eine Art | Wert |
|---|---|---|
| apikey * | string | API-Schlüssel zur Autorisierung der Anfrage |
Antworten:
{
"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":""
}
]
}
Verbindungsaufzeichnungsdaten:
| Name | Eine Art | Beschreibung |
|---|---|---|
| id | number | Systeminterne Verbindungs-ID |
| status | number |
Verbindungsstatus. Mögliche Werte:
|
| create_time | unixtime | Datum und Uhrzeit des Verbindungsaufbaus |
| invite_code | string | Einladungscode |
| invite_url | string | URL für Einladung |
| connect_url | string | Die URL zum Anhängen des Operators an die Verbindung |
| client_name | string | Kundenname |
| client_os | string |
Operationssystem. Mögliche Werte: win, mac, linux und android
Das Feld wird gefüllt, nachdem der Kunde beigetreten ist |
| client_preview_url | string |
Client-Desktop-Miniaturansicht
Das Feld wird gefüllt, nachdem der Kunde beigetreten ist |
Zusätzliche Daten:
| Name | Eine Art | Beschreibung |
|---|---|---|
| remain | number | Die Anzahl der verbleibenden Verbindungen innerhalb des Tarifplans |
Verbindung herstellen
Um eine ausstehende 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>
Anfrageparameter:
| Parameter | Eine Art | Wert |
|---|---|---|
| apikey * | string | API-Schlüssel zur Autorisierung der Anfrage |
| client_name | string | Kundenname (nur für Sie sichtbar). Optionaler Parameter. |
Antworten:
{
"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":""
}
]
}
Verbindung beitreten
| Name | Eine Art | Beschreibung |
|---|---|---|
| id | number | Systeminterne Verbindungs-ID |
| status | number |
Verbindungsstatus. Mögliche Werte:
|
| create_time | unixtime | Datum und Uhrzeit des Verbindungsaufbaus |
| invite_code | string | Einladungscode |
| invite_url | string | URL für Einladung |
| connect_url | string | Die URL zum Anhängen des Operators an die Verbindung |
| client_name | string | Kundenname |
| client_os | string |
Operationssystem. Mögliche Werte: win, mac, linux und android
Das Feld wird gefüllt, nachdem der Kunde beigetreten ist |
| client_preview_url | string |
Client-Desktop-Miniaturansicht
Das Feld wird gefüllt, nachdem der Kunde beigetreten ist |
Verbindungsinformationen
Um Informationen zu einer bestimmten Verbindung zu erhalten, verwenden Sie die Methode support/info
Anfrage:
GET https://api.getscreen.me/v1/support/info ?apikey=<string> &connection_id=<number>
Anfrageparameter:
| Parameter | Eine Art | Wert |
|---|---|---|
| apikey * | string | API-Schlüssel zur Autorisierung der Anfrage |
| connection_id * | number | Systeminterne Verbindungs-ID |
Antworten:
{
"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:
| Name | Eine Art | Beschreibung |
|---|---|---|
| id | number | Systeminterne Verbindungs-ID |
| status | number |
Verbindungsstatus. Mögliche Werte:
|
| create_time | unixtime | Datum und Uhrzeit des Verbindungsaufbaus |
| invite_code | string | Einladungscode |
| invite_url | string | URL für Einladung |
| connect_url | string | Die URL zum Anhängen des Operators an die Verbindung |
| client_name | string | Kundenname |
| client_os | string |
Operationssystem. Mögliche Werte: win, mac, linux und android
Das Feld wird gefüllt, nachdem der Kunde beigetreten ist |
| client_preview_url | string |
Client-Desktop-Miniaturansicht
Das Feld wird gefüllt, nachdem der Kunde beigetreten ist |
Verbindung schließen
Um die Verbindung zu beenden, verwenden Sie die Methode support/close
Anfrage:
POST https://api.getscreen.me/v1/support/close ?apikey=<string> &connection_id=<number>
Anfrageparameter:
| Parameter | Eine Art | Wert |
|---|---|---|
| apikey * | string | API-Schlüssel zur Autorisierung der Anfrage |
| connection_id * | number | Systeminterne Verbindungs-ID |
Antworten:
Die Antwort kommt mit leerem Inhalt. Verwenden Sie nur den HTTP-Antwortcode, um die Befehlsausführung zu analysieren.
Rufen Sie eine Liste der Verbindungen auf
Um eine Liste 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>
Anfrageparameter:
| Parameter | Eine Art | Wert |
|---|---|---|
| apikey * | string | API-Schlüssel zur Autorisierung 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 des Zeitraums |
| video | boolean | Nach Videoaufnahme filtern |
| offset | number | Die erste Position in der Liste einrücken |
| limit | number | Die Anzahl der Elemente in der Liste. Standard ist 20, Maximalwert ist 100 |
Antworten:
{
"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:
| Name | Eine Art | Beschreibung |
|---|---|---|
| id | number | Systeminterne Verbindungs-ID |
| start | unixtime | Startdatum und -uhrzeit der Verbindung |
| stop | unixtime |
Datum und Uhrzeit des Verbindungsendes
Kann leer sein, wenn die Verbindung nicht abgeschlossen ist |
| clients | array | Liste der Kunden, die der Verbindung beigetreten sind |
| clients[.]user_agent | string | User-Agent |
| clients[.]login | string |
Benutzer-Anmeldung
Kann leer sein, wenn die Verbindung anonym war |
| clients[.]geo | object | Geo-Standort |
| clients[.]geo.ip | string | IP Adresse |
| clients[.]geo.country | string | Land |
| clients[.]geo.region | string | Region |
| clients[.]geo.city | string | Stadt |
| agent | object | Agenteninformationen |
| agent.id | number | Systeminterne Agentenkennung |
| agent.name | string | Name |
| agent.group | string | Gruppe |
| agent.geo | object | Geo-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 | Operationssystem. Mögliche Werte: win, mac, linux und android |
| agent.version | string | Programmversion |
| agent.owner | string | Login des Kontos des Inhabers des permanenten Zugangs |
| video | object |
Informationen zur Videoaufnahme
Kann fehlen, wenn die Videoaufnahme nicht verbunden war |
| video.url | string |
Adresse zum Hochladen der Videoaufnahmedatei
Um die Videodatei der Verbindungsaufzeichnung zu laden, müssen Sie den Parameter ?apikey= mit dem Wert Ihres API-Schlüssels hinzufügen. |
| video.size | number | Größe der Aufnahmevideodatei in Byte |
