L'API 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.
Les revendeurs peuvent envoyer les requêtes API en utilisant la clé API générée pour leur compte dans la console web.
Pour obtenir la clé API :
- Connectez-vous à votre compte RemotePC Revendeur.
- Accédez à l'onglet Mon compte 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.
1. Ajouter un utilisateur
URL : https://web1.remotepc.com/rpc-api/reseller/private/user/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Requête
string firstName;
string lastName;
string invitedUserEmailId;
string password;
integer allotedComputers; //paramètre facultatif, la valeur par défaut est 0
boolean sendEmailToUser; //la notification par e-mail à l'utilisateur est un paramètre facultatif
Codes de réponse HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Exemple de requête
{ "firstName": "firstname", "lastName": "lastname", "invitedUserEmailId": "[email protected]", "password": "password", "allotedComputers": 1, "sendEmailToUser": true }
Exemple de réponse (Succès)
{ "status": "OK", "code": 200, "message": "SUCCESS" }
Exemple de réponse d'erreur
{ "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" }] }
La description peut inclure :
- FIRSTNAME_REQUIRED,
- LASTNAME_REQUIRED,
- EMAILID_REQUIRED,
- ENTER_VALID_EMAIL,
- PASSWORD_REQUIRED,
- INVALID_PASSWORD
2. Inviter des utilisateurs
URL : https://web1.remotepc.com/rpc-api/reseller/private/user/invite
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Requête
string invitedUserEmailId;
integer allotedComputers; //paramètre facultatif, la valeur par défaut est 0
Codes de réponse HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Exemple de requête
[{ "invitedUserEmailId": "[email protected]", "allotedComputers": 10 }]
Exemple de réponse (Succès)
{ "status": "OK", "code": 200, "message": [{ "username": "[email protected]", "status": "ALREADY_INVITED" }, { "username": "[email protected]", "status": "EXISTS" }, { "username": "[email protected]", "status": "INVITED" }] }
Exemple de réponse d'erreur
{ "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. Connexion utilisateur
URL : https://web1.remotepc.com/rpc-api/reseller/private/user/signin
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Requête
string username;
string password;
Codes de réponse HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Exemple de requête
{ "username": "username", "password": "password" }
Exemple de réponse (Succès)
{ "status": "OK", "code": 200, "message": { "rpc_redirect_link": "https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9" } }
Remarque : Utilisez rpc_redirect_link pour vous connecter automatiquement au compte.
Exemple de réponse d'erreur
{ "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" }] }
La description peut inclure
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. Liste des utilisateurs
URL : https://web1.remotepc.com/rpc-api/reseller/private/user/list
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Codes de réponse HTTP
200 (Success)
500 (Server Error)
401 (Unauthorized)
Exemple de réponse (Succès)
{ "status": "OK", "code": 200, "message": { "resellerUsersList": [{ "alloted_computers": 1, "created_date": "01-13-2023", "isActive": true, "utilized_computers": 0, "username": "[email protected]" }] } }
Exemple de réponse d'erreur
{ "status": "UNAUTHORIZED", "code": 401, "errorsCount": 1, "errors": [{ "description": "UNAUTHORIZED_ACCESS" }] }
{ "status": "INTERNAL_SERVER_ERROR", "code": 500, "errorsCount": 1, "errors": [{ "description": "INTERNAL_SERVER_ERROR" }] }