RemotePC Enterprise API akzeptiert Anfragen und gibt Antworten im 'JSON'-Format zurück. Der API-Schlüssel-Authentifizierungsmechanismus wird zusammen mit IP-Whitelisting verwendet, um die APIs zu authentifizieren. Für alle APIs muss der API-Schlüssel im Autorisierungs-Header hinzugefügt werden.
Sie können die API-Anfragen mit dem für Ihr Konto generierten API-Schlüssel in der Web-Konsole senden.
So erhalten Sie den API-Schlüssel:
- Melden Sie sich bei Ihrem RemotePC Enterprise-Konto an.
- Gehen Sie zur Registerkarte My Account und klicken Sie auf API Keys.
- Klicken Sie auf View, geben Sie das Kontopasswort ein und klicken Sie auf View.
- Der API-Schlüssel wird angezeigt. Klicken Sie auf Copy Key, um ihn in die Zwischenablage zu kopieren.
Um den API-Schlüssel zu ändern, klicken Sie auf Change. Geben Sie das Kontopasswort ein und klicken Sie auf View, um den neuen API-Schlüssel anzuzeigen.
Hinweis: Nur der Administrator (Kontoinhaber) kann den API-Schlüssel generieren.
1. Benutzer einladen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage
string[]: email - Pflichtfeld
int: status_2FA - Optional (erlaubte Werte sind 0 und 1; 1 - Status EIN & 0 - Status AUS)
int: sso_flag - Optional (erlaubte Werte sind 0 und 1; 1 - SSO aktivieren & 0 - SSO deaktivieren)
Hinweis: SSO muss zuerst auf dem Administratorkonto konfiguriert werden, um es für Benutzer zu aktivieren. Wenn SSO nicht auf dem Administratorkonto eingerichtet ist, kann es für keinen Benutzer aktiviert werden.
Http-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Anfrage-Beispiel 1
{
"email": [
"shane@myworld"
]
}
Anfrage-Beispiel 2
{
"email": [
"shane@myworld"
],
"status_2FA":1,
"sso_flag":1
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Fehler-Antwort-Beispiel
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Beschreibung kann enthalten
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status
2. Benutzer erstellen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage
string: firstname - Pflichtfeld
string: lastname - Pflichtfeld
string: username - Pflichtfeld
string: password - Pflichtfeld
int: status_2FA - Optional (erlaubte Werte sind 0 und 1; 1 - Status EIN & 0 - Status AUS)
int: sso_flag - Optional (erlaubte Werte sind 0 und 1; 1 - SSO aktivieren & 0 - SSO deaktivieren)
Hinweis: SSO muss zuerst auf dem Administratorkonto konfiguriert werden, um es für Benutzer zu aktivieren. Wenn SSO nicht auf dem Administratorkonto eingerichtet ist, kann es für keinen Benutzer aktiviert werden.
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Anfrage-Beispiel 1
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Anfrage-Beispiel 2
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1,
"sso_flag":1
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
Beschreibung kann enthalten
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
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage
string[]: sub_ids - Pflichtfeld
string[]: invited_ids - Pflichtfeld
sub_ids: E-Mail-IDs aktiver Benutzer,
invited_ids: E-Mail-IDs eingeladener Benutzer
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Anfrage-Beispiel
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Fehler-Antwort-Beispiel
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Beschreibung kann enthalten
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
4. Benutzer abrufen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage
Int pageIndex - Optional
Int recordPerPage - Optional, Standard ist 500
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"pageIndex": 1,
"recordPerPage": 30
}
Antwort-Beispiel
{
"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"
]
}
}
}
Erwartetes Fehler-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Beschreibung kann enthalten
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Hinweis: Die maximale Anzahl an Benutzerlisten, die gleichzeitig angefordert werden können, beträgt 500.
5. Computer dem Benutzer zuweisen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage
string: username - Pflichtfeld
string[]: computer_names - Pflichtfeld
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Beschreibung kann enthalten
Username is required
Computer names are not found in the request
User not found
Computer(s) not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
6. Computerzuweisung für Benutzer aufheben
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage
string: username - Pflichtfeld
string[]: computer_names - Pflichtfeld
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Beschreibung kann enthalten
Username is required
Computer names are not found in the request
User not found
Computer(s) not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
7. Gruppe erstellen und Computer verschieben
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage
string: group_name - Pflichtfeld
string[]: computer_names - Optional
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
Beschreibung kann enthalten
Username is required
Computer names are not found in the request
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Group name can not be blank
Group name is already exists
Invalid group name
8. Computer entfernen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage
string[]: computer_names - Pflichtfeld
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Beschreibung kann enthalten:
Invalid user
Computer names are not found in the request
Exceeded computers limit
Computer(s) not found
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Hinweis: Nur offline Computer können entfernt werden. Es können jeweils bis zu 50 Computer entfernt werden.
9. Kommentar für Computer hinzufügen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage:
string: computer_name - Pflichtfeld
string: comment_desc - Pflichtfeld
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Beschreibung kann enthalten
Username is required
Computer name can not be blank
Comments can not be blank
Comments length should be between 6 to 250
Computer not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
10. Geräte abrufen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage:
Int pageIndex - Optional
Int recordPerPage - Optional, Standard ist 500
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"pageIndex": 1,
"recordPerPage": 30
}
Antwort-Beispiel
{
"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"
}
]
"pagination": {
"records_per_page": 30,
"total_records": 2,
"total_page_count": 1,
"current_page_index": 1
}
}
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Beschreibung kann enthalten
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Hinweis: Die maximale Anzahl an Gerätelisten, die gleichzeitig angefordert werden können, beträgt 500.
11. Benutzergeräte abrufen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Anfrage:
Int pageIndex - Optional
Int recordPerPage - Optional, Standard ist 500
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"pageIndex": 1,
"recordPerPage": 30,
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": {
"devices": [...],
"pagination": {
"records_per_page": 30,
"total_records": 2,
"total_page_count": 1,
"current_page_index": 1
}
}
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Beschreibung kann enthalten
Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Hinweis: Die maximale Anzahl an Gerätelisten, die gleichzeitig angefordert werden können, beträgt 500.
12. Computer in eine Gruppe verschieben
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
Method-Type: POST
Request headers:
- Authorization header: Bearer <api key>
- Content-type: application/json
Anfrage:
string: group_name - Pflichtfeld
string[]: computer_names - Pflichtfeld
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Erwartete Fehlerantwort
Computer names are not found in the request
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Group name can not be blank
Group name does not exists
Invalid group name
13. Web-Viewer-Verbindungs-URL abrufen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/get/connectUrl
Method-Type: POST
Request headers:
- Authorization header: Bearer <api key>
- Content-type: application/json
Anfrage:
string: machine_id - Pflichtfeld
string: username - Pflichtfeld
HTTP-Antwort
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Anfrage-Beispiel
{
"username": "abc@xyz",
"machine_id": "GVHR654GBUYJH"
}
Antwort-Beispiel
{
"status": "OK",
"code": 200,
"message": "https://login.remotepc.com/rpcnew/viewer/redirect/msp/connect/process/abc"
}
Fehler-Antwort-Beispiel
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid machine_id"
}
]
}
Beschreibung kann enthalten
Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username