La API RemotePC acepta solicitudes y devuelve respuestas en formato 'JSON'. El mecanismo de autenticación de clave de API se utiliza junto con listas blancas de IP para autenticar las API. Para todas las API, debe añadirse la clave de API en el encabezado de autorización.
Los revendedores pueden enviar las solicitudes API utilizando la clave API generada para su cuenta en la consola web.
Para obtener la clave API,
- Acceda a su cuenta de Revendedor RemotePC.
- 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. Añadir usuario
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; //parámetro opcional, por defecto 0
boolean sendEmailToUser; //la notificación por correo electrónico al usuario es un parámetro opcional
Códigos de respuesta HTTP
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": "shane@idrive.com",
"password": "password",
"allotedComputers": 1,
"sendEmailToUser": true
}
Respuesta
Ejemplo de respuesta satisfactoria
{
"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:
- NOMBRE_REQUERIDO,
- APELLIDO_REQUERIDO,
- EMAILID_REQUIRED,
- ENTER_VALID_EMAIL,
- PASSWORD_REQUIRED,
- CONTRASEÑA_NO_VALIDA
2. Invitar a los usuarios
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; //parámetro opcional, por defecto es 0.
Códigos de respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
Solicitar muestra
[
{
"invitedUserEmailId": "shane@idrive.com",
"allotedComputers": 10
}
]
Ejemplo de respuesta satisfactoria
{
"status": "OK",
"code": 200,
"message": [
{
"username": "shane@idrive.com",
"status": "ALREADY_INVITED"
},
{
"username": "shane@idrive.com",
"status": "EXISTS"
},
{
"username": "shane@idrive.com",
"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. Inicio de sesión de usuario
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
cadena nombre de usuario;
cadena contraseña;
Códigos de respuesta HTTP
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"
}
Respuesta
Ejemplo de respuesta satisfactoria
{
"status": "OK",
"code": 200,
"message": {
"rpc_redirect_link":"https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9"
}
}
Nota: Utilice rpc_redirect_link para iniciar sesión automáticamente en la cuenta.
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,
NOMBRE_USUARIO_REQUERIDO
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
4. Lista de usuarios
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
Códigos de respuesta HTTP
200 (correcto)
500 (Error del servidor)
401 (No autorizado)
Respuesta
Ejemplo de respuesta satisfactoria
{
"status": "OK",
"code": 200,
"message":{
"resellerUsersList": [
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 425,
"created_date": "01-25-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
}
]
}
}
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"
}
]
}