RemotePC^™ Reseller APIs

Die RemotePC 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.

Reseller 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:

1. Melden Sie sich bei Ihrem RemotePC Reseller-Konto an.
2. Gehen Sie zur Registerkarte Mein Konto und klicken Sie auf API Keys.
3. Klicken Sie auf View, geben Sie das Kontokennwort ein und klicken Sie auf View.
4. 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 Kontokennwort ein und klicken Sie auf View, um den neuen API-Schlüssel anzuzeigen.

1. Benutzer hinzufügen

URL: https://web1.remotepc.com/rpc-api/reseller/private/user/add

              Method-Type: POST

              Request headers:

              

                
Authorization: Bearer <api key>
                
Content-type: application/json
              
            

Anfrage

              string firstName;

              string lastName;

              string invitedUserEmailId;

              string password;

              integer allotedComputers; //optionaler Parameter, Standard ist 0

              boolean sendEmailToUser; //E-Mail-Benachrichtigung an Benutzer ist ein optionaler Parameter

            

HTTP-Antwortcodes

              200 (Success)

              500 (Server Error)

              400 (Invalid Parameters)

              401 (Unauthorized)

              403 (Invalid request)
            

Anforderungsbeispiel

              {

                  "firstName": "firstname",

                  "lastName": "lastname",

                  "invitedUserEmailId": "[email protected]",

                  "password": "password",

                  "allotedComputers": 1,

                  "sendEmailToUser": true

              }
            

Antwortbeispiel (Erfolg)

              {

                  "status": "OK",

                  "code": 200,

                  "message": "SUCCESS"

              }
            

Antwortfehlerbeispiel

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

Beschreibung kann enthalten:

1. FIRSTNAME_REQUIRED,
2. LASTNAME_REQUIRED,
3. EMAILID_REQUIRED,
4. ENTER_VALID_EMAIL,
5. PASSWORD_REQUIRED,
6. INVALID_PASSWORD

2. Benutzer einladen

URL: https://web1.remotepc.com/rpc-api/reseller/private/user/invite

              Method-Type: POST

              Request headers:

              

                
Authorization: Bearer <api key>
                
Content-type: application/json
              
            

Anfrage

              string invitedUserEmailId;

              integer allotedComputers; //optionaler Parameter, Standard ist 0

            

HTTP-Antwortcodes

              200 (Success)

              500 (Server Error)

              400 (Invalid Parameters)

              401 (Unauthorized)

              403 (Invalid request)
            

Anforderungsbeispiel

              [{ "invitedUserEmailId": "[email protected]", "allotedComputers": 10 }]
            

Antwortbeispiel (Erfolg)

              {

                  "status": "OK", "code": 200,

                  "message": [

                    { "username": "[email protected]", "status": "ALREADY_INVITED" },

                    { "username": "[email protected]", "status": "EXISTS" },

                    { "username": "[email protected]", "status": "INVITED" }

                  ]

              }
            

Antwortfehlerbeispiel

              { "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. Benutzeranmeldung

URL: https://web1.remotepc.com/rpc-api/reseller/private/user/signin

              Method-Type: POST

              Request headers:

              

                
Authorization: Bearer <api key>
                
Content-type: application/json
              
            

Anfrage

              string username;

              string password;

            

HTTP-Antwortcodes

              200 (Success)

              500 (Server Error)

              400 (Invalid Parameters)

              401 (Unauthorized)

              403 (Invalid request)
            

Anforderungsbeispiel

{ "username": "username", "password": "password" }

Antwortbeispiel (Erfolg)

              {

                  "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 beim Konto anzumelden.

Antwortfehlerbeispiel

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

Beschreibung kann enthalten

EMAILID_REQUIRED,
INVALID_EMAIL,
PASSWORD_REQUIRED,
USERNAME_REQUIRED

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

              Method-Type: POST

              Request headers:

              

                
Authorization: Bearer <api key>
                
Content-type: application/json
              
            

HTTP-Antwortcodes

              200 (Success)

              500 (Server Error)

              401 (Unauthorized)
            

Antwortbeispiel (Erfolg)

              {

                  "status": "OK", "code": 200,

                  "message": { "resellerUsersList": [

                    { "alloted_computers": 1, "created_date": "01-13-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]" }

                  ]}

              }
            

Antwortfehlerbeispiel

{ "status": "UNAUTHORIZED", "code": 401, "errorsCount": 1, "errors": [{ "description": "UNAUTHORIZED_ACCESS" }] }

{ "status": "INTERNAL_SERVER_ERROR", "code": 500, "errorsCount": 1, "errors": [{ "description": "INTERNAL_SERVER_ERROR" }] }