RemotePC
    Anglais
    • Español
    • 日本語
    • Deutsche
    • Français
    • Italiano
    • Português
    • Português-BR
    • 한국어
    • Dutch
    • Turkish

    Menu

    • Mon compte
    • Connexion
    • S'inscrire
    • Anglais
      • Español
      • 日本語
      • Deutsche
      • Français
      • Italiano
      • Português
      • Português-BR
      • 한국어
      • Dutch
      • Turkish
    • Caractéristiques
    • Fixation des prix
    • Télécharger

    API d'entreprise

    • API d'entreprise
      • Inviter les utilisateurs
      • Créer un utilisateur
      • Supprimer les utilisateurs
      • Obtenir des utilisateurs
      • Attribuer un ordinateur
      • Désaffecter l'ordinateur
      • Créer un groupe et déplacer des ordinateurs
      • Supprimer les ordinateurs
      • Ajouter un commentaire pour l'ordinateur
      • Obtenir des dispositifs
      • Déplacer des ordinateurs dans un groupe

    L'API RemotePC Enterprise accepte les demandes et renvoie les réponses au format 'JSON'. Le mécanisme d'authentification par clé API est utilisé avec la liste blanche d'adresses 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,

    1. Connectez-vous à votre compte RemotePC Enterprise.
    2. Allez dans l'onglet Mon compte et cliquez sur Clés API.
    3. Cliquez sur Afficher, saisissez le mot de passe du compte, puis cliquez sur Afficher.
    4. La clé API s'affiche. Cliquez sur Copy Key pour la copier dans le presse-papiers.

    Pour modifier la clé API, cliquez sur Modifier. Saisissez le mot de passe du compte et cliquez sur Afficher pour voir la nouvelle clé API.

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

    1. Inviter l'utilisateur

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

     
                            Type de méthode : POST
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande

                           string[] : email - Obligatoire
    int : status_2FA - Facultatif (les valeurs autorisées sont 0 et 1 ; 1 - état ON & 0 - état OFF)

    Réponse Http

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)

    Demande d'échantillon 1

                            {
     "email": [
      "[email protected]"
     ]
    }

    Demande d'échantillon 2

                            {
     "email": [
      "[email protected]"
     ],
     "status_2FA":1
    }

    Echantillon de réponse

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

    Exemple d'erreur de réponse

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

    La description peut comprendre

                            FAILED
    ERREUR_SERVEUR_INTERNE
    Utilisateur non valide
    Permission d'utilisateur non valide
    Plan d'utilisateur invalide
    Statut à deux facteurs invalide

    2. Créer un utilisateur

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

     
                          Type de méthode : POST
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande

                            string : firstname - Obligatoire
    string : lastname - Obligatoire
    string : nom d'utilisateur - Obligatoire
    string : password - Obligatoire
    int : status_2FA - Facultatif (les valeurs autorisées sont 0 et 1 ; 1 - état activé et 0 - état désactivé)

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)

    Demande d'échantillon 1

                               {
      "firstname": "firstname",
      "lastname": "lastname",
      "username": "[email protected]",
      "password": "password"
    }

    Demande d'échantillon 2

                               {
      "firstname": "firstname",
      "lastname": "lastname",
      "username": "[email protected]",
      "password": "password",
      "status_2FA":1
    }

    Echantillon de réponse

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Exemple d'erreur de réponse

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Email is already in use or already invited."
        }
      ]
    }

    La description peut comprendre

                            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 ~`[email protected]#$%^&*()-_+={}|[];\'\"<>,.?/
    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. Supprimer l'utilisateur

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

     
                          Type de méthode : POST
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande

                            string[] : sub_ids - Obligatoire
    string[] : invited_ids - Obligatoire
                            sub_ids: IDs e-mail des utilisateurs actifs,
    invited_ids: IDs e-mail des utilisateurs invités

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)

    Demander un échantillon

                            {
      "sub_ids":[
       "[email protected]",
       "[email protected]",
       "[email protected]"
      ],
      "invited_ids":[
        "[email protected]"
      ],
    }

    Echantillon de réponse

                            {
      "status": "OK",
      "code": 200,
      "message": {
       "active_user_delete_status": {
        "[email protected]": "FAILED"
       },
        "invited_user_delete_status": {
        "[email protected]": "SUCCESS"
        }
      }
    }

    Exemple d'erreur de réponse

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

    La description peut comprendre

                            FAILED
    INTERNAL_SERVER_ERROR
    Utilisateur non valide
    Autorisation d'utilisateur non valide
    Plan d'utilisateur non valide

    4. Obtenir des utilisateurs

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

     
                            Type de méthode : GET
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande

                            Int pageIndex - Facultatif
    Int recordPerPage - Facultatif, la valeur par défaut est 500

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)
    404 (Non trouvé)

    Demander un échantillon

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

    Echantillon de réponse

                            {
      "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": "[email protected]",
          "lastname": "lastname"
         ]
       }
      }
    }

    Echantillon d'erreurs attendues

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Invalid page index"
        }
      ]
    }

    La description peut comprendre

                            Utilisateur non valide
    Autorisation non valide de l'utilisateur
    INTERNAL_SERVER_ERROR
    Plan de l'utilisateur non valide
    Index de page non valide

    Note: Le nombre maximum de listes d'utilisateurs à demander en même temps est de 500.

    5. Attribuer un ordinateur à l'utilisateur

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

     
                            Type de méthode : POST
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande

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

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)
    404 (Non trouvé)

    Demander un échantillon

                            {
      "username": "[email protected]",
      "computer_names": [
       "Computer A",
       "Computer B"
      ],
    }

    Echantillon de réponse

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Exemple d'erreur de réponse

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Computer name can not be blank"
        }
      ]
    }

    La description peut comprendre

                            Le nom d'utilisateur est requis
    Les noms d'ordinateurs ne sont pas trouvés dans la requête
    Utilisateur non trouvé
    Ordinateur(s) non trouvé(s)
    Utilisateur non valide
    Autorisation de l'utilisateur non valide
    INTERNAL_SERVER_ERROR
    Plan d'utilisateur non valide

    6. Désassigner l'ordinateur à l'utilisateur

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

     
                            Type de méthode : POST
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande

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

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)
    404 (Non trouvé)

    Demander un échantillon

                            {
      "username": "[email protected]",
      "computer_names": [
       "Computer A",
       "Computer B"
      ],
    }

    Echantillon de réponse

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Exemple d'erreur de réponse

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Computer names are not found in the request"
        }
      ]
    }

    La description peut comprendre

                            Le nom d'utilisateur est requis
    Les noms d'ordinateurs ne sont pas trouvés dans la requête
    Utilisateur non trouvé
    Ordinateur(s) non trouvé(s)
    Utilisateur non valide
    Autorisation de l'utilisateur non valide
    INTERNAL_SERVER_ERROR
    Plan d'utilisateur non valide

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

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

     
                            Type de méthode : POST
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande

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

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)
    404 (Non trouvé)

    Demander un échantillon

                            {
      "group_name": "Group A",
      "computer_names": [
       "Computer A",
       "Computer B"
      ],
    }

    Echantillon de réponse

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Exemple d'erreur de réponse

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Group name is already exists"
        }
      ]
    }

    La description peut comprendre

                            Le nom d'utilisateur est requis
    Les noms d'ordinateurs ne sont pas trouvés dans la requête
    Utilisateur non valide
    Autorisation de l'utilisateur non valide
    INTERNAL_SERVER_ERROR
    Plan d'utilisateur non valide
    Le nom de groupe ne peut pas être vide
    Le nom du groupe existe déjà
    Nom de groupe non valide

    8. Retirer le(s) ordinateur(s)

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

     
                            Type de méthode : POST
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande

                            string[] : computer_names - Obligatoire

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)
    404 (Non trouvé)

    Demander un échantillon

                            {
      "computer_names": [
       "Computer A",
       "Computer B"
      ],
    }

    Echantillon de réponse

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Exemple d'erreur de réponse

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Computer names are not found in the request"
        }
      ]
    }

    La description peut inclure :

                            Utilisateur non valide
    Les noms d'ordinateurs ne sont pas trouvés dans la requête
    Limite d'ordinateurs dépassée
    Ordinateur(s) non trouvé(s)
    Autorisation d'utilisateur non valide
    ERREUR_SERVEUR_INTERNE
    Plan d'utilisateur non valide

    Remarque: seuls les ordinateurs hors ligne peuvent être supprimés. Il est possible de supprimer jusqu'à 50 ordinateurs à la fois.

    9. Ajouter un commentaire pour l'ordinateur

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

     
                            Type de méthode : POST
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande :

                            string : computer_name - Obligatoire
    string : comment_desc - Obligatoire

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)
    404 (Non trouvé)

    Demander un échantillon

                            {
       "comment_desc": "This is my computer",
      "computer_name": "Computer A"
    }

    Echantillon de réponse

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Exemple d'erreur de réponse

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Computer name can not be blank"
        }
      ]
    }

    La description peut comprendre

                            Le nom d'utilisateur est obligatoire
    Le nom de l'ordinateur ne peut pas être vide
    Les commentaires ne peuvent pas être vides
    La longueur des commentaires doit être comprise entre 6 et 250
    Ordinateur non trouvé
    Utilisateur non valide
    Autorisation d'utilisateur non valide
    INTERNAL_SERVER_ERROR
    Plan d'utilisateur non valide

    10. Obtenir des appareils

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

     
                            Type de méthode : GET
    En-têtes de la demande :
    • Authorization: Bearer <api key>
    • Content-type : application/json

    Demande :

                            Int pageIndex - Facultatif
    Int recordPerPage - Facultatif, la valeur par défaut est 500

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)
    404 (Non trouvé)

    Demander un échantillon

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

    Echantillon de réponse

                            {
      "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"
         }
        {
         "machine_id": "###################",
         "host_name": "Computer B",
         "host_os_version": "10.0",
         "host_ip": "0.0.0.0",
         "viewer_last_session_time": "2023-02-24 10:56:01",
         "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
        }
      }
    }

    Exemple d'erreur de réponse

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Invalid page index"
        }
      ]
    }

    La description peut comprendre

                            Utilisateur non valide
    Autorisation non valide de l'utilisateur
    INTERNAL_SERVER_ERROR
    Plan de l'utilisateur non valide
    Index de page non valide

    Remarque: le nombre maximal de listes de périphériques à demander en même temps est de 500.

    11. Déplacer des ordinateurs dans un groupe

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

     
                            Type de méthode : POST
    En-têtes de la demande :
    • Authorization header: Bearer <api key>
    • Content-type : application/json

    Demande :

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

    Réponse HTTP

                            200 (succès)
    500 (erreur de serveur)
    400 (Paramètres non valides)
    401 (Non autorisé)
    403 (Requête invalide)
    404 (Non trouvé)

    Demander un échantillon

                            {
      "group_name": "Group A",
      "computer_names": [
        "Computer A",
        "Computer B"
      ]
    }

    Echantillon de réponse

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Exemple d'erreur de réponse

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
        {
          "description": "Group name does not exists"
        }
      ]
    }

    Réponse d'erreur attendue

                            Les noms d'ordinateurs ne sont pas trouvés dans la demande
    Utilisateur non valide
    Permission d'utilisateur non valide
    ERREUR_SERVEUR_INTERNE
    Plan d'utilisateur non valide
    Le nom du groupe ne peut pas être vide
    Le nom du groupe n'existe pas
    Nom de groupe invalide
    • RemotePC™

    • Caractéristiques
    • Fixation des prix
    • Équipe
    • Entreprise
    • Accès via le Web
    • Accès par mobile
    • Entreprise
    • Commencez

    • Télécharger
    • S'inscrire
    • FAQs
    • Tutoriels vidéo
    • Services

    • Partenaires
    • Conformité
    • Mentions légales

    • Conditions d'utilisation
    • Politique de confidentialité
    • Politique d'utilisation acceptable

    Soutien


    © IDrive Inc.