La API empresarial de RemotePC acepta solicitudes y devuelve respuestas en formato 'JSON'. Se utiliza el mecanismo de autenticación mediante clave API junto con la lista blanca de IPs para autenticar las APIs. Para todas las APIs, la clave API debe añadirse en el encabezado de autorización.
Puedes enviar las solicitudes de API utilizando la clave API generada para tu cuenta en la consola web.
Para obtener la clave API,
- Iniciar sesión en tu cuenta empresarial de RemotePC.
- Ve a la pestaña Mi cuenta y haz clic en Claves API.
- Haz clic en Ver, introduce la contraseña de la cuenta y haz clic en Ver.
- Se mostrará la clave API. Haz clic en Copiar clave para copiarla al portapapeles.
Para cambiar la clave API, haz clic en Cambiar. Introduce la contraseña de la cuenta y haz clic en Ver para ver la nueva clave API.
Nota: Solo el administrador (propietario de la cuenta) puede generar la clave API.
1. Invitar usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido
string[]: email - Mandatory
int: status_2FA - Optional (allowed values are 0 and 1; 1 - Status ON & 0 - Status OFF)
int: sso_flag - Optional (allowed values are 0 and 1; 1 - Enable SSO & 0 - Disable SSO)
Nota: SSO debe estar configurado en la cuenta de Administrador para poder habilitarlo para los usuarios. Si SSO no está configurado en la cuenta de Administrador, no se puede habilitar para ningún usuario.
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Ejemplo de pedido 1
{
"email": [
"shane@myworld"
]
}
Ejemplo de pedido 2
{
"email": [
"shane@myworld"
],
"status_2FA":1,
"sso_flag":1
}
Ejemplo de respuesta
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Ejemplo de error de respuesta
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
La descripción puede incluir
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status
2. Crear usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido
string: firstname - Mandatory
string: lastname - Mandatory
string: username - Mandatory
string: password - Mandatory
int: status_2FA - Optional (allowed values are 0 and 1; 1 - Status ON & 0 - Status OFF)
int: sso_flag - Optional (allowed values are 0 and 1; 1 - Enable SSO & 0 - Disable SSO)
Nota: SSO debe estar configurado en la cuenta de Administrador para poder habilitarlo para los usuarios. Si SSO no está configurado en la cuenta de Administrador, no se puede habilitar para ningún usuario.
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Solicitar muestra 1
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Solicitar muestra 2
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1,
"sso_flag":1
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
La descripción puede incluir
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 ~`!@#$%^&*()-_+={}|[];\'\"<>,.?/
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. Eliminar usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido
string[]: sub_ids - Mandatory
string[]: invited_ids - Mandatory
sub_ids: Active User Email IDs,
invited_ids: Invited User Email IDs
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Solicitar muestra
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Ejemplo de error de respuesta
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
La descripción puede incluir
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
4. Obtener usuarios
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"pageIndex": 1,
"recordPerPage": 30
}
Muestra de respuesta
{
"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": "shane@mymail",
"lastname": "lastname"
]
}
}
}
Muestra de error esperado
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
La descripción puede incluir
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Nota: El número máximo de listas de usuarios que se pueden solicitar a la vez es 500.
5. Asignar computadora al usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido
string: username - Mandatory
string[]: computer_names - Mandatory
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
La descripción puede incluir
Username is required
Computer names are not found in the request
User not found
Computer(s) not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
6. Desasignar computadora al usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido
string: username - Mandatory
string[]: computer_names - Mandatory
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
La descripción puede incluir
Username is required
Computer names are not found in the request
User not found
Computer(s) not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
7. Crear un grupo y mover computadoras
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido
string: group_name - Mandatory
string[]: computer_names - Optional
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
La descripción puede incluir
Username is required
Computer names are not found in the request
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Group name can not be blank
Group name is already exists
Invalid group name
8. Eliminar computadora(s)
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido
string[]: computer_names - Mandatory
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
La descripción puede incluir:
Invalid user
Computer names are not found in the request
Exceeded computers limit
Computer(s) not found
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Nota: Solo se pueden eliminar ordenadores sin conexión. Se pueden eliminar hasta 50 ordenadores a la vez.
9. Agregar comentario para la computadora
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido:
string: computer_name - Mandatory
string: comment_desc - Mandatory
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
La descripción puede incluir
Username is required
Computer name can not be blank
Comments can not be blank
Comments length should be between 6 to 250
Computer not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
10. Obtener dispositivos
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"pageIndex": 1,
"recordPerPage": 30
}
Muestra de respuesta
{
"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
}
}
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
La descripción puede incluir
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Nota: El número máximo de listas de dispositivos que se pueden solicitar a la vez es 500.
11. Obtener dispositivos de usuarios
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Pedido:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"pageIndex": 1,
"recordPerPage": 30,
}
Muestra de respuesta
{
"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
}
}
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
La descripción puede incluir
Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Nota: El número máximo de listas de dispositivos que se pueden solicitar a la vez es 500.
12. Mover computadoras a un grupo
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
Method-Type: POST
Request headers:
- Authorization header: Bearer <api key>
- Content-type: application/json
Pedido:
string: group_name- Mandatory
string[]: computer_names- Mandatory
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Respuesta de error esperada
Computer names are not found in the request
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Group name can not be blank
Group name does not exists
Invalid group name
13. Obtener la URL de conexión del visor web
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/get/connectUrl
Method-Type: POST
Request headers:
- Authorization header: Bearer <api key>
- Content-type: application/json
Pedido:
string: machine_id - Mandatory
string: username - Mandatory
Respuesta HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Solicitar muestra
{
"username": "abc@xyz",
"machine_id": "GVHR654GBUYJH"
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "https://login.remotepc.com/rpcnew/viewer/redirect/msp/connect/process/abc"
}
Ejemplo de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid machine_id"
}
]
}
La descripción puede incluir
Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username