RemotePC^™ Enterprise APIs

L'API Enterprise di RemotePC accetta richieste e restituisce risposte nel formato 'JSON'. Il meccanismo di autenticazione con chiave API viene utilizzato insieme all'inserimento nell'elenco IP consentiti per autenticare le API. Per tutte le API, la chiave API deve essere aggiunta nell'intestazione di autorizzazione.

È possibile inviare le richieste API utilizzando la chiave API generata per il proprio account nella console web.
Per ottenere la chiave API:

1. Accedere al proprio account RemotePC Enterprise.
2. Andare alla scheda My Account e fare clic su API Keys.
3. Fare clic su View, inserire la password dell'account e fare clic su View.
4. La chiave API verrà visualizzata. Fare clic su Copy Key per copiare negli appunti.

Per modificare la chiave API, fare clic su Change. Inserire la password dell'account e fare clic su View per visualizzare la nuova chiave API.

Nota: Solo l'amministratore (proprietario dell'account) può generare la chiave API.

1. Invita utenti

URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite

 
            Method-Type: POST

            Request headers:

            

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

Richiesta

           string[]: email - Obbligatorio

           int: status_2FA - Facoltativo (valori consentiti 0 e 1; 1 - Stato ATTIVO & 0 - Stato INATTIVO)

           int: sso_flag - Facoltativo (valori consentiti 0 e 1; 1 - Abilita SSO & 0 - Disabilita SSO)

          

Nota: SSO deve essere configurato prima sull'account Administrator per abilitarlo per gli utenti. Se SSO non è configurato sull'account Administrator, non può essere abilitato per nessun utente.

Risposta Http

            200 (Success)

            500 (Server Error)

            400 (Invalid Parameters)

            401 (Unauthorized)

            403 (Invalid request)
          

Esempio di richiesta 1

            {

               "email": [

                    "shane@myworld"

               ]

          }
          

Esempio di richiesta 2

            {

               "email": [

                    "shane@myworld"

               ],

               "status_2FA":1,

                "sso_flag":1

          }
          

Esempio di risposta

            {

                "status": "OK",

                "code": 200,

                "message": {

                              "invalid_list": [...],

                             "invited_list": [...]

                         }

            }

          

Esempio di risposta di errore

            {

                "status": "INTERNAL_SERVER_ERROR",

                "code": 500,

                "errorsCount": 1,

                "errors": [{ "description": "INTERNAL_SERVER_ERROR" }]

          }
          

La descrizione può includere

            FAILED

            INTERNAL_SERVER_ERROR

            Invalid user

            Invalid user permission

            Invalid user plan

            Invalid two factor status
          

2. Crea utente

URL: https://web1.remotepc.com/rpcnew/api/msp/user/create

 
          Method-Type: POST

          Request headers:

          

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

Richiesta

            string: firstname - Obbligatorio

            string: lastname - Obbligatorio

            string: username - Obbligatorio

            string: password - Obbligatorio

            int: status_2FA - Facoltativo

            int: sso_flag - Facoltativo
          

Nota: SSO deve essere configurato prima sull'account Administrator per abilitarlo per gli utenti. Se SSO non è configurato sull'account Administrator, non può essere abilitato per nessun utente.

Risposta HTTP

            200 (Success)

            500 (Server Error)

            400 (Invalid Parameters)

            401 (Unauthorized)

            403 (Invalid request)
          

Esempio di richiesta 1

               {

                    "firstname": "firstname",

                    "lastname": "lastname",

                    "username": "shane@myworld",

                    "password": "password"

                 }

          

Esempio di richiesta 2

               {

                    "firstname": "firstname",

                    "lastname": "lastname",

                    "username": "shane@myworld",

                    "password": "password",

                    "status_2FA":1,

                    "sso_flag":1

                 }

          

Esempio di risposta

            {

                "status": "OK",

                "code": 200,

                "message": "SUCCESS"

            }

          

Esempio di risposta di errore

            {

                "status": "BAD_REQUEST",

                "code": 400,

                "errorsCount": 1,

                "errors": [{ "description": "Email is already in use or already invited." }]

            }

          

La descrizione può includere

            FAILED

            INTERNAL_SERVER_ERROR

            Invalid user

            Invalid user permission

            Invalid user plan

            First name cannot be blank

            Last name cannot be blank

            Username/Email cannot be blank

            Enter a valid Username/Email

            Password cannot be blank

            Email is already in use or already invited.

            Invalid two factor status
          

3. Elimina utenti

URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete

 
          Method-Type: POST

          Request headers:

          

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

Richiesta

            string[]: sub_ids - Obbligatorio

            string[]: invited_ids - Obbligatorio

          

            sub_ids: ID email utenti attivi,

            invited_ids: ID email utenti invitati

          

Risposta HTTP

            200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
          

Esempio di richiesta

            {

                  "sub_ids":["diane@myworld","pam@myworld","bill@myworld"],

                  "invited_ids":["jamie@myworld"]

            }
          

Esempio di risposta

            {

                "status": "OK",

                "code": 200,

                "message": {

                       "active_user_delete_status": {"carol@myworld": "FAILED"},

                       "invited_user_delete_status": {"aaron@myworld": "SUCCESS"}

              }

          }
          

La descrizione può includere

FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan

4. Ottieni utenti

URL: https://web1.remotepc.com/rpcnew/api/msp/user/list

 
            Method-Type: GET

            Request headers:

            

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

Richiesta

            Int pageIndex - Facoltativo

            Int recordPerPage - Facoltativo, Default è 500

          

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

Esempio di richiesta

{ "pageIndex": 1, "recordPerPage": 30 }

La descrizione può includere

Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index

Nota: Il numero massimo di elenchi utenti da richiedere contemporaneamente è 500.

5. Assegna computer all'utente

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign

 
            Method-Type: POST

            Request headers:

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

Richiesta

string: username - Obbligatorio
string[]: computer_names - Obbligatorio

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

La descrizione può includere

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. Rimuovi assegnazione computer all'utente

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign

 
            Method-Type: POST

            Request headers:

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

Richiesta

string: username - Obbligatorio
string[]: computer_names - Obbligatorio

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

La descrizione può includere

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. Crea gruppo e sposta computer

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create

 
            Method-Type: POST

            Request headers:

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

Richiesta

string: group_name - Obbligatorio
string[]: computer_names - Facoltativo

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

La descrizione può includere

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. Rimuovi computer

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove

 
            Method-Type: POST

            Request headers:

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

Richiesta

string[]: computer_names - Obbligatorio

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

La descrizione può includere:

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

Nota: Solo i computer offline possono essere rimossi. Alla volta è possibile rimuovere fino a 50 computer.

9. Aggiungi commento per il computer

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add

 
            Method-Type: POST

            Request headers:

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

Richiesta:

string: computer_name - Obbligatorio
string: comment_desc - Obbligatorio

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

La descrizione può includere

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. Ottieni dispositivi

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list

 
            Method-Type: GET

            Request headers:

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

Richiesta:

Int pageIndex - Facoltativo
Int recordPerPage - Facoltativo, Default è 500

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

La descrizione può includere

Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index

Nota: Il numero massimo di elenchi di dispositivi da richiedere contemporaneamente è 500.

11. Ottieni dispositivi utenti

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}

 
            Method-Type: GET

            Request headers:

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

Richiesta:

Int pageIndex - Facoltativo
Int recordPerPage - Facoltativo, Default è 500

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

La descrizione può includere

Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index

Nota: Il numero massimo di elenchi di dispositivi da richiedere contemporaneamente è 500.

12. Sposta computer in un gruppo

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
          

Richiesta:

string: group_name - Obbligatorio
string[]: computer_names - Obbligatorio

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

Risposta di errore prevista

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. Ottieni URL di connessione Web Viewer

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
          

Richiesta:

string: machine_id - Obbligatorio
string: username - Obbligatorio

Risposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

Esempio di richiesta

{ "username": "abc@xyz", "machine_id": "GVHR654GBUYJH" }

La descrizione può includere

Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username