L'API RemotePC 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 des adresses 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 des 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 revendeur RemotePC.
- Allez dans l'onglet Mon compte et cliquez sur Clés API.
- Cliquez sur Afficher, saisissez le mot de passe du compte, puis cliquez sur Afficher.
- 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.
1. Ajouter un utilisateur
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/add
Type de méthode : POST
En-têtes de la demande :
- Authorization: Bearer <api key>
- Content-type : application/json
Demande
chaîne de caractères prénom ;
chaîne de caractères lastName ;
string invitedUserEmailId ;
string password ;
integer allotedComputers ; //paramètre facultatif, la valeur par défaut est 0
boolean sendEmailToUser ; //la notification par courriel à l'utilisateur est un paramètre facultatif
Codes de 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
{
"firstName": "firstname",
"lastName": "lastname",
"invitedUserEmailId": "[email protected]",
"password": "password",
"allotedComputers": 1,
"sendEmailToUser": true
}
Réponse
Exemple de réussite de la réponse
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Exemple d'erreur de réponse
{
"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 :
- PRÉNOM OBLIGATOIRE,
- NOM DE FAMILLE REQUIS,
- EMAILID_REQUIRED,
- ENTER_VALID_EMAIL,
- MOT_DE_PASSE REQUIS,
- MOT_DE_PASSE INVALIDE
2. Inviter les utilisateurs
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/invite
Type de méthode : POST
En-têtes de la demande :
- Authorization: Bearer <api key>
- Content-type : application/json
Demande
string invitedUserEmailId ;
integer allotedComputers ; //paramètre facultatif, la valeur par défaut est 0
Codes de 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
[
{
"invitedUserEmailId": "[email protected]",
"allotedComputers": 10
}
]
Exemple de réussite de la réponse
{
"status": "OK",
"code": 200,
"message": [
{
"username": "[email protected]",
"status": "ALREADY_INVITED"
},
{
"username": "[email protected]",
"status": "EXISTS"
},
{
"username": "[email protected]",
"status": "INVITED"
}
]
}
Exemple d'erreur de réponse
{
"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 de l'utilisateur
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/signin
Type de méthode : POST
En-têtes de la demande :
- Authorization: Bearer <api key>
- Content-type : application/json
Demande
chaîne de caractères nom d'utilisateur ;
mot de passe (string) ;
Codes de 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
{
"username": "username",
"password": "password"
}
Réponse
Exemple de réussite de la réponse
{
"status": "OK",
"code": 200,
"message": {
"rpc_redirect_link":"https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9"
}
}
Note : Utilisez rpc_redirect_link pour vous connecter automatiquement au compte.
Exemple d'erreur de réponse
{
"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 comprendre
EMAILID_REQUIRED,
INVALID_EMAIL,
PASSWORD_REQUIRED,
NOM D'UTILISATEUR_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
Type de méthode : POST
En-têtes de la demande :
- Authorization: Bearer <api key>
- Content-type : application/json
Codes de réponse HTTP
200 (succès)
500 (Erreur du serveur)
401 (non autorisé)
Réponse
Exemple de réussite de la réponse
{
"status": "OK",
"code": 200,
"message":{
"resellerUsersList": [
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-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]"
}
]
}
}
Exemple d'erreur de réponse
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "UNAUTHORIZED_ACCCESS"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}