RemotePC 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.
Wiederverkäufer können die API-Anfragen mit dem API-Schlüssel senden, der für ihr Konto in der Webkonsole generiert wurde.
Um den API-Schlüssel zu erhalten,
- Melden Sie sich bei Ihrem RemotePC Reseller-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.
1. Benutzer hinzufügen
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/add
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string firstName;
string lastName;
string invitedUserEmailId;
string passwort;
integer allotedComputers; //optionaler Parameter, Standardwert ist 0
boolean sendEmailToUser; //E-Mail-Benachrichtigung an den Benutzer ist ein optionaler Parameter
HTTP-Antwortcodes
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
Muster anfordern
{
"firstName": "firstname",
"lastName": "lastname",
"invitedUserEmailId": "[email protected]",
"password": "password",
"allotedComputers": 1,
"sendEmailToUser": true
}
Antwort
Muster einer erfolgreichen Antwort
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "EMAIL_EXISTS"
}
]
}
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
{
"status": "Forbidden",
"code": 403,
"errorsCount": 1,
"errors": [
{
"description": "Forbidden "
}
]
}
Die Beschreibung kann Folgendes umfassen:
- VORNAME_ERFORDERLICH,
- NACHNAME_ERFORDERLICH,
- EMAILID_ERFORDERLICH,
- EINGEBEN_GÜLTIGE_E-MAIL,
- PASSWORT_ERFORDERLICH,
- UNGÜLTIGES_PASSWORT
2. Benutzer einladen
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/invite
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string invitedUserEmailId;
integer allotedComputers; //optionaler Parameter, Standardwert ist 0
HTTP-Antwortcodes
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
Muster anfordern
[
{
"invitedUserEmailId": "[email protected]",
"allotedComputers": 10
}
]
Muster einer erfolgreichen Antwort
{
"status": "OK",
"code": 200,
"message": [
{
"username": "[email protected]",
"status": "ALREADY_INVITED"
},
{
"username": "[email protected]",
"status": "EXISTS"
},
{
"username": "[email protected]",
"status": "INVITED"
}
]
}
Antwortfehlerprobe
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
{
"status": "Forbidden",
"code": 403,
"errorsCount": 1,
"errors": [
{
"description": "Forbidden "
}
]
}
3. Anmeldung des Benutzers
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/signin
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
Anfrage
string username;
string passwort;
HTTP-Antwortcodes
200 (Erfolg)
500 (Serverfehler)
400 (Ungültige Parameter)
401 (Nicht autorisiert)
403 (Ungültige Anfrage)
Muster anfordern
{
"username": "username",
"password": "password"
}
Antwort
Muster einer erfolgreichen Antwort
{
"status": "OK",
"code": 200,
"message": {
"rpc_redirect_link":"https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9"
}
}
Hinweis: Verwenden Sie rpc_redirect_link, um sich automatisch bei dem Konto anzumelden.
Antwortfehlerprobe
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "USERNAME_DOES_NOT_EXIST"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "ACTION_PARENT_ACCOUNT_SUSPENDED"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "IP_ADDRESS_BLOCKED"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "CANCELLED_ACCOUNT"
}
]
}
Die Beschreibung kann umfassen
EMAILID_ERFORDERLICH,
INVALID_EMAIL,
PASSWORT_ERFORDERLICH,
BENUTZERNAME_ERFORDERLICH
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
4. Benutzerliste
URL:https://web1.remotepc.com/rpc-api/reseller/private/user/list
Methoden-Typ: POST
Kopfzeilen der Anfrage:
- Authorization: Bearer <api key>
- Inhaltstyp: application/json
HTTP-Antwortcodes
200 (Erfolg)
500 (Serverfehler)
401 (Nicht autorisiert)
Antwort
Muster einer erfolgreichen Antwort
{
"status": "OK",
"code": 200,
"message":{
"resellerUsersList": [
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 425,
"created_date": "01-25-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
}
]
}
}
Antwortfehlerprobe
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "UNAUTHORIZED_ACCCESS"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}