RemotePC Enterprise API nimmt Anfragen entgegen und gibt Antworten im JSON-Format zurück. Der API-Schlüssel-Authentifizierungsmechanismus wird zusammen mit IP-Whitelisting zur Authentifizierung der APIs verwendet. Für alle APIs muss der API-Schlüssel im Autorisierungs-Header hinzugefügt werden.
Sie können die API-Anfragen mit dem API-Schlüssel senden, der für Ihr Konto in der Webkonsole generiert wurde.
So erhalten Sie den API-Schlüssel,
- Melden Sie sich bei Ihrem RemotePC Enterprise-Konto an.
- Gehen Sie zur Registerkarte Mein Konto und klicken Sie auf API-Schlüssel.
- Klicken Sie auf Anzeigen, geben Sie das Kontopasswort ein und klicken Sie auf Anzeigen.
- Der API-Schlüssel wird angezeigt. Klicken Sie auf Schlüssel kopieren, um ihn in die Zwischenablage zu kopieren.
Um den API-Schlüssel zu ändern, klicken Sie auf Ändern. Geben Sie das Kontopasswort ein und klicken Sie auf Anzeigen, um den neuen API-Schlüssel anzuzeigen.
Hinweis: Nur der Admin (Kontoinhaber) kann den API-Schlüssel generieren.
1. Benutzer einladen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string[]: email - Obligatorisch
int: status_2FA - Optional (zulässige Werte sind 0 und 1; 1 - Status ON & 0 - Status OFF)
Http-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
Muster 1 anfordern
{
"email": [
"shane@myworld"
]
}
Muster 2 anfordern
{
"email": [
"shane@myworld"
],
"status_2FA":1
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Antwortfehlerprobe
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Die Beschreibung kann umfassen
FAILED
INTERNAL_SERVER_ERROR
Ungültiger Benutzer
Ungültige Benutzerberechtigung
Ungültiger Benutzerplan
Ungültiger Zwei-Faktor-Status
2. Benutzer anlegen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string: vorname - Obligatorisch
string: nachname - Obligatorisch
string: benutzername - Obligatorisch
string: passwort - Obligatorisch
int: status_2FA - Optional (zulässige Werte sind 0 und 1; 1 - Status ON & 0 - Status OFF)
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
Muster 1 anfordern
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Muster 2 anfordern
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
Die Beschreibung kann umfassen
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
First name cannot be blank
First name can contain a-z, A-Z and space
Last name cannot be blank
Last name can contain a-z, A-Z and space
Username/Email cannot be blank
Enter a valid Username/Email
Password cannot be blank
Password can contain A-Z, a-z, 0-9 and ~`!@#$%^&*()-_+={}|[];\'\"<>,.?/
Password should be between 6 - 20 characters
Email is already in use or already invited.
Email in use with other Admin
Invalid two factor status
3. Benutzer löschen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string[]: sub_ids - Obligatorisch
string[]: invited_ids - Obligatorisch
sub_ids: E-Mail-IDs aktiver Benutzer,
invited_ids: Eingeladene Benutzer-E-Mail-IDs
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
Muster anfordern
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Antwortfehlerprobe
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Die Beschreibung kann umfassen
FAILED
INTERNAL_SERVER_ERROR
Ungültiger Benutzer
Ungültige Benutzerberechtigung
Ungültiger Benutzerplan
4. Benutzer erhalten
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Methoden-Typ: GET
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
Int pageIndex - Kann
Int recordPerPage - Optional, Standardwert ist 500
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
404 (Nicht gefunden)
Muster anfordern
{
"pageIndex": 1,
"recordPerPage": 30
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": {
"pagination": {
"records_per_page": 30,
"total_records": 1,
"total_page_count": 1,
"current_page_index": 1
}
"users": [
{
"firstname": "firstname",
"username": "shane@mymail",
"lastname": "lastname"
]
}
}
}
Erwartete Fehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Die Beschreibung kann umfassen
Ungültiger Benutzer
Ungültige Benutzerberechtigung
INTERNAL_SERVER_ERROR
Ungültiger Benutzerplan
Ungültiger Seitenindex
Hinweis: Es können maximal 500 Benutzerlisten auf einmal angefordert werden.
5. Computer dem Benutzer zuweisen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string: username - Obligatorisch
string[]: computer_names - Obligatorisch
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
404 (Nicht gefunden)
Muster anfordern
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Die Beschreibung kann umfassen
Benutzername ist erforderlich
Computernamen werden in der Anfrage nicht gefunden
Benutzer nicht gefunden
Computer nicht gefunden
Ungültiger Benutzer
Ungültige Benutzerberechtigung
INTERNAL_SERVER_ERROR
Ungültiger Benutzerplan
6. Zuordnung des Computers zum Benutzer aufheben
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string: username - Obligatorisch
string[]: computer_names - Obligatorisch
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
404 (Nicht gefunden)
Muster anfordern
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Die Beschreibung kann umfassen
Benutzername ist erforderlich
Computernamen werden in der Anfrage nicht gefunden
Benutzer nicht gefunden
Computer nicht gefunden
Ungültiger Benutzer
Ungültige Benutzerberechtigung
INTERNAL_SERVER_ERROR
Ungültiger Benutzerplan
7. Gruppe erstellen und Computer verschieben
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string: group_name - Obligatorisch
string[]: computer_names - Optional
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
404 (Nicht gefunden)
Muster anfordern
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
Die Beschreibung kann umfassen
Benutzername ist erforderlich
Computernamen werden in der Anfrage nicht gefunden
Ungültiger Benutzer
Ungültige Benutzerberechtigung
INTERNAL_SERVER_ERROR
Ungültiger Benutzerplan
Gruppenname kann nicht leer sein
Gruppenname ist bereits vorhanden
Ungültiger Gruppenname
8. Entfernen Sie den/die Computer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string[]: computer_names - Obligatorisch
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
404 (Nicht gefunden)
Muster anfordern
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Die Beschreibung kann Folgendes umfassen:
Ungültiger Benutzer
Computernamen werden in der Anfrage nicht gefunden
Überschreitung des Computerlimits
Computer wurde(n) nicht gefunden
Ungültige Benutzerberechtigung
INTERNAL_SERVER_ERROR
Ungültiger Benutzerplan
Hinweis: Es können nur Offline-Computer entfernt werden. Es können bis zu 50 Computer auf einmal entfernt werden.
9. Kommentar für Computer hinzufügen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage:
string: computer_name - Obligatorisch
string: comment_desc - Obligatorisch
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
404 (Nicht gefunden)
Muster anfordern
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Die Beschreibung kann umfassen
Benutzername ist erforderlich
Der Computername darf nicht leer sein
Kommentare dürfen nicht leer sein
Die Länge der Kommentare sollte zwischen 6 und 250 liegen.
Computer nicht gefunden
Ungültiger Benutzer
Ungültige Benutzerberechtigung
INTERNAL_SERVER_ERROR
Ungültiger Benutzerplan
10. Geräte holen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Methoden-Typ: GET
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage:
Int pageIndex - Kann
Int recordPerPage - Optional, Standardwert ist 500
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
404 (Nicht gefunden)
Muster anfordern
{
"pageIndex": 1,
"recordPerPage": 30
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": {
"devices": [
{
"machine_id": "###################",
"host_name": "Computer A",
"host_os_version": "10.0",
"host_ip": "0.0.0.0",
"viewer_last_session_time": "2023-02-24 11:07:11",
"comments": "",
"host_os_text": "Windows",
"host_status_text": "Offline"
}
{
"machine_id": "###################",
"host_name": "Computer B",
"host_os_version": "10.0",
"host_ip": "0.0.0.0",
"viewer_last_session_time": "2023-02-24 10:56:01",
"comments": "",
"host_os_text": "Windows",
"host_status_text": "Offline"
}
]
"pagination": {
"records_per_page": 30,
"total_records": 2,
"total_page_count": 1,
"current_page_index": 1
}
}
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Die Beschreibung kann umfassen
Ungültiger Benutzer
Ungültige Benutzerberechtigung
INTERNAL_SERVER_ERROR
Ungültiger Benutzerplan
Ungültiger Seitenindex
Hinweis: Es können maximal 500 Gerätelisten auf einmal angefordert werden.
11. Computer in eine Gruppe verschieben
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization header: Bearer <api key>
- Inhaltstyp: application/json
Anfrage:
string: group_name- Obligatorisch
string[]: computer_names- Obligatorisch
HTTP-Antwort
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
404 (Nicht gefunden)
Muster anfordern
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Antwortmuster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Erwartete Fehlerantwort
Computernamen werden in der Anfrage nicht gefunden
Ungültiger Benutzer
Ungültige Benutzerberechtigung
INTERNAL_SERVER_ERROR
Ungültiger Benutzerplan
Gruppenname kann nicht leer sein
Gruppenname existiert nicht
Ungültiger Gruppenname