RemotePC API accepts requests and returns responses in the 'JSON' format. The API Key Authentication mechanism is used along with IP whitelisting to authenticate the APIs. For all the APIs, API Key must be added in the authorization header.
Resellers can send the API requests using the API Key generated for their account in the web console.
Para obtener la clave API,
- Log in to your RemotePC Reseller account.
- Vaya a la pestaña Mi cuenta y haga clic en Claves API.
- Haga clic en Ver, introduzca la contraseña de la cuenta y haga clic en Ver.
- Aparecerá la clave API. Haga clic en Copiar clave para copiarla en el portapapeles.
Para cambiar la clave API, haga clic en Cambiar. Introduzca la contraseña de la cuenta y haga clic en Ver para ver la nueva clave de API.
1. Add user
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/add
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string firstName;
string lastName;
string invitedUserEmailId;
string password;
integer allotedComputers; //optional parameter, default is 0
boolean sendEmailToUser; //email notification to user is an optional parameter
HTTP response codes
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
Solicitar muestra
{
"firstName": "firstname",
"lastName": "lastname",
"invitedUserEmailId": "[email protected]",
"password": "password",
"allotedComputers": 1,
"sendEmailToUser": true
}
Response
Response success sample
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Muestra de error de respuesta
{
"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 descripción puede incluir:
- FIRSTNAME_REQUIRED,
- LASTNAME_REQUIRED,
- EMAILID_REQUIRED,
- ENTER_VALID_EMAIL,
- PASSWORD_REQUIRED,
- INVALID_PASSWORD
2. Invite users
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/invite
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string invitedUserEmailId;
integer allotedComputers; //optional parameter, default is 0
HTTP response codes
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
Solicitar muestra
[
{
"invitedUserEmailId": "[email protected]",
"allotedComputers": 10
}
]
Response success sample
{
"status": "OK",
"code": 200,
"message": [
{
"username": "[email protected]",
"status": "ALREADY_INVITED"
},
{
"username": "[email protected]",
"status": "EXISTS"
},
{
"username": "[email protected]",
"status": "INVITED"
}
]
}
Muestra de error de respuesta
{
"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. User sign in
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/signin
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string username;
string password;
HTTP response codes
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
Solicitar muestra
{
"username": "username",
"password": "password"
}
Response
Response success sample
{
"status": "OK",
"code": 200,
"message": {
"rpc_redirect_link":"https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9"
}
}
Note: Use rpc_redirect_link to auto login to the account.
Muestra de error de respuesta
{
"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 descripción puede incluir
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. User list
URL:https://web1.remotepc.com/rpc-api/reseller/private/user/list
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
HTTP response codes
200 (Success)
500 (Server Error)
401 (Unauthorized)
Response
Response success sample
{
"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]"
}
]
}
}
Muestra de error de respuesta
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "UNAUTHORIZED_ACCESS"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}