RemotePC™ - Enterprise APIs

L'API Enterprise de RemotePC accepte les requêtes et retourne les réponses au format 'JSON'. Le mécanisme d'authentification par clé API est utilisé avec la mise en liste blanche des IP pour authentifier les API. Pour toutes les API, la clé API doit être ajoutée dans l'en-tête d'autorisation.

Vous pouvez envoyer les requêtes API en utilisant la clé API générée pour votre compte dans la console web.
Pour obtenir la clé API :

Connectez-vous à votre compte RemotePC Enterprise.
Accédez à l'onglet My Account et cliquez sur API Keys.
Cliquez sur View, saisissez le mot de passe du compte et cliquez sur View.
La clé API s'affichera. Cliquez sur Copy Key pour la copier dans le presse-papiers.

Pour modifier la clé API, cliquez sur Change. Saisissez le mot de passe du compte et cliquez sur View pour afficher la nouvelle clé API.

Remarque : Seul l'administrateur (propriétaire du compte) peut générer la clé API.

1. Inviter des utilisateurs

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

 
            Method-Type: POST

            Request headers:

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

Requête

           string[]: email - Obligatoire

           int: status_2FA - Facultatif (valeurs autorisées 0 et 1; 1 - Statut ACTIVÉ & 0 - Statut DÉSACTIVÉ)

           int: sso_flag - Facultatif (valeurs autorisées 0 et 1; 1 - Activer SSO & 0 - Désactiver SSO)

Remarque : SSO doit d'abord être configuré sur le compte administrateur pour l'activer pour les utilisateurs. Si SSO n'est pas configuré sur le compte administrateur, il ne peut pas être activé pour aucun utilisateur.

Réponse Http

            200 (Success)

            500 (Server Error)

            400 (Invalid Parameters)

            401 (Unauthorized)

            403 (Invalid request)

Exemple de requête 1

            {

               "email": [

                    "shane@myworld"

               ]

          }

Exemple de requête 2

            {

               "email": ["shane@myworld"],

               "status_2FA":1,

               "sso_flag":1

          }

Exemple de réponse

            { "status": "OK", "code": 200, "message": { "invalid_list": [...], "invited_list": [...] } }

La description peut inclure

FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status

2. Créer un utilisateur

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

 
          Method-Type: POST

          Request headers:

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

Requête

            string: firstname - Obligatoire

            string: lastname - Obligatoire

            string: username - Obligatoire

            string: password - Obligatoire

            int: status_2FA - Facultatif

            int: sso_flag - Facultatif

Remarque : SSO doit d'abord être configuré sur le compte administrateur pour l'activer pour les utilisateurs.

Réponse HTTP

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

La description peut inclure

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
Email is already in use or already invited.
Invalid two factor status

3. Supprimer des utilisateurs

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

 
          Method-Type: POST

          Request headers:

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

Requête

            string[]: sub_ids - Obligatoire

            string[]: invited_ids - Obligatoire

            sub_ids : ID e-mail des utilisateurs actifs,

            invited_ids : ID e-mail des utilisateurs invités

La description peut inclure

FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan

4. Obtenir des utilisateurs

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

 
            Method-Type: GET

            Request headers:

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

Requête

Int pageIndex - Facultatif
Int recordPerPage - Facultatif, Défaut est 500

Réponse HTTP

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

La description peut inclure

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

Remarque : Le nombre maximum de listes d'utilisateurs à demander à la fois est de 500.

5. Attribuer un ordinateur à l'utilisateur

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

 
            Method-Type: POST

            Request headers:

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

Requête

string: username - Obligatoire
string[]: computer_names - Obligatoire

La description peut inclure

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. Désattribuer un ordinateur à l'utilisateur

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

 
            Method-Type: POST

            Request headers:

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

Requête

string: username - Obligatoire
string[]: computer_names - Obligatoire

La description peut inclure

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. Créer un groupe et déplacer des ordinateurs

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

 
            Method-Type: POST

            Request headers:

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

Requête

string: group_name - Obligatoire
string[]: computer_names - Facultatif

La description peut inclure

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. Supprimer des ordinateurs

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

 
            Method-Type: POST

            Request headers:

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

Requête

string[]: computer_names - Obligatoire

La description peut inclure :

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

Remarque : Seuls les ordinateurs hors ligne peuvent être supprimés. À la fois, jusqu'à 50 ordinateurs peuvent être supprimés.

9. Ajouter un commentaire pour l'ordinateur

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

 
            Method-Type: POST

            Request headers:

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

Requête :

string: computer_name - Obligatoire
string: comment_desc - Obligatoire

La description peut inclure

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. Obtenir des appareils

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

 
            Method-Type: GET

            Request headers:

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

Requête :

Int pageIndex - Facultatif
Int recordPerPage - Facultatif, Défaut est 500

La description peut inclure

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

Remarque : Le nombre maximum de listes d'appareils à demander à la fois est de 500.

11. Obtenir les appareils des utilisateurs

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

 
            Method-Type: GET

            Request headers:

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

Requête :

Int pageIndex - Facultatif
Int recordPerPage - Facultatif, Défaut est 500

La description peut inclure

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

Remarque : Le nombre maximum de listes d'appareils à demander à la fois est de 500.

12. Déplacer des ordinateurs vers un groupe

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

Requête :

string: group_name - Obligatoire
string[]: computer_names - Obligatoire

Réponse d'erreur attendue

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. Obtenir l'URL de connexion 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

Requête :

string: machine_id - Obligatoire
string: username - Obligatoire

La description peut inclure

Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username

RemotePC™ Enterprise APIs

1. Inviter des utilisateurs

2. Créer un utilisateur

3. Supprimer des utilisateurs

4. Obtenir des utilisateurs

5. Attribuer un ordinateur à l'utilisateur

6. Désattribuer un ordinateur à l'utilisateur

7. Créer un groupe et déplacer des ordinateurs

8. Supprimer des ordinateurs

9. Ajouter un commentaire pour l'ordinateur

10. Obtenir des appareils

11. Obtenir les appareils des utilisateurs

12. Déplacer des ordinateurs vers un groupe

13. Obtenir l'URL de connexion Web Viewer

RemotePC^™ Enterprise APIs