RemotePC Enterprise API acepta peticiones 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, API Key debe añadirse en el encabezado de autorización.
Puede 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 RemotePC Enterprise.
- 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.
Nota: Sólo el administrador (propietario de la cuenta) puede generar la clave API.
1. Invitar al usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string[]: email - Obligatorio
int: status_2FA - Opcional (los valores permitidos son 0 y 1; 1 - Estado ON & 0 - Estado OFF)
int: sso_flag - Opcional (los valores permitidos son 0 y 1; 1 - Activar SSO & 0 - Desactivar SSO)
Nota: El SSO debe configurarse primero en la cuenta de Administrador para habilitarlo para los usuarios. Si el SSO no está configurado en la cuenta de Administrador, no podrá habilitarse para ningún usuario.
Respuesta http
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
Solicitar muestra 1
{
"email": [
"shane@myworld"
]
}
Solicitar muestra 2
{
"email": [
"shane@myworld"
],
"status_2FA":1,
"sso_flag":1
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Muestra de error de respuesta
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
La descripción puede incluir
FALLÓ
INTERNAL_SERVER_ERROR
Usuario no válido
Permiso de usuario no válido
Plan de usuario no válido
Estado de dos factores no válido
2. Crear usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string: firstname - Obligatorio
string: lastname - Obligatorio
string: username - Obligatorio
string: password - Obligatorio
int: status_2FA - Opcional (los valores permitidos son 0 y 1; 1 - Estado ON y 0 - Estado OFF)
int: sso_flag - Opcional (los valores permitidos son 0 y 1; 1 - Activar SSO & 0 - Desactivar SSO)
Nota: El SSO debe configurarse primero en la cuenta de Administrador para habilitarlo para los usuarios. Si el SSO no está configurado en la cuenta de Administrador, no podrá habilitarse para ningún usuario.
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
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"
}
Muestra 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
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string[]: sub_ids - Obligatorio
string[]: invited_ids - Obligatorio
sub_ids: ID de correo electrónico de usuarios activos,
invited_ids: ID de correo electrónico de los usuarios invitados
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
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"
}
}
}
Muestra de error de respuesta
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
La descripción puede incluir
FALLÓ
INTERNAL_SERVER_ERROR
Usuario no válido
Permiso de usuario no válido
Plan de usuario no válido
4. Obtener usuarios
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Tipo de método: GET
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
Int pageIndex - Opcional
Int recordPerPage - Opcional, Por defecto 500
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
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"
]
}
}
}
Error esperado muestra
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
La descripción puede incluir
Usuario no válido
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
Índice de página no válido
Nota: El número máximo de listas de usuarios a solicitar a la vez es de 500.
5. Asignar ordenador al usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string: nombre_usuario - Obligatorio
string[]: computer_names - Obligatorio
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
Solicitar muestra
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Muestra de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
La descripción puede incluir
El nombre de usuario es obligatorio
Los nombres de los ordenadores no se encuentran en la solicitud
Usuario no encontrado
Ordenador(es) no encontrado(s)
Usuario no válido
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
6. Desasignar ordenador al usuario
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string: nombre_usuario - Obligatorio
string[]: computer_names - Obligatorio
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
Solicitar muestra
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Muestra 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
El nombre de usuario es obligatorio
Los nombres de los ordenadores no se encuentran en la solicitud
Usuario no encontrado
Ordenador(es) no encontrado(s)
Usuario no válido
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
7. Crear grupo y mover ordenadores
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
cadena: nombre_grupo - Obligatorio
string[]: computer_names - Opcional
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
Solicitar muestra
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Muestra de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
La descripción puede incluir
El nombre de usuario es obligatorio
Los nombres de los ordenadores no se encuentran en la solicitud
Usuario no válido
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
El nombre del grupo no puede estar en blanco
El nombre del grupo ya existe
Nombre de grupo no válido
8. Retirar ordenador(es)
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Solicitar
string[]: computer_names - Obligatorio
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
Solicitar muestra
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Muestra 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:
Usuario no válido
Los nombres de los ordenadores no se encuentran en la solicitud
Se ha superado el límite de ordenadores
Ordenador(es) no encontrado(s)
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
Nota: Sólo se pueden eliminar ordenadores desconectados. Se pueden eliminar hasta 50 equipos a la vez.
9. Añadir comentario para ordenador
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Tipo de método: POST
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Petición:
string: computer_name - Obligatorio
string: comment_desc - Obligatorio
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
Solicitar muestra
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Muestra de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
La descripción puede incluir
El nombre de usuario es obligatorio
El nombre del ordenador no puede estar en blanco
Los comentarios no pueden estar en blanco
La longitud de los comentarios debe estar entre 6 y 250
Ordenador no encontrado
Usuario no válido
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
10. Obtener dispositivos
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Tipo de método: GET
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Petición:
Int pageIndex - Opcional
Int recordPerPage - Opcional, Por defecto 500
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
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
}
}
}
Muestra de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
La descripción puede incluir
Usuario no válido
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
Índice de página no válido
Nota: El número máximo de listas de dispositivos a solicitar a la vez es de 500.
11. Obtener los dispositivos de los usuarios
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
Tipo de método: GET
Cabeceras de solicitud:
- Authorization: Bearer <api key>
- Content-type: application/json
Petición:
Int pageIndex - Opcional
Int recordPerPage - Opcional, Por defecto 500
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
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
}
}
}
Muestra de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
La descripción puede incluir
Usuario no válido
Nombre de usuario no válido
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
Índice de página no válido
Nota: El número máximo de listas de dispositivos a solicitar a la vez es de 500.
12. Mover ordenadores a un grupo
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
Tipo de método: POST
Cabeceras de solicitud:
- Authorization header: Bearer <api key>
- Content-type: application/json
Petición:
cadena: group_name- Obligatorio
string[]: computer_names- Obligatorio
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
Solicitar muestra
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Muestra de respuesta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Muestra de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Respuesta de error esperada
Los nombres de los ordenadores no se encuentran en la solicitud
Usuario no válido
Permiso de usuario no válido
INTERNAL_SERVER_ERROR
Plan de usuario no válido
El nombre del grupo no puede estar en blanco
El nombre del grupo no existe
Nombre de grupo no válido
13. Obtener URL de conexión del visor web
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/get/connectUrl
Tipo de método: POST
Cabeceras de solicitud:
- Authorization header: Bearer <api key>
- Content-type: application/json
Petición:
string: machine_id - Obligatorio
cadena: nombre_usuario - Obligatorio
Respuesta HTTP
200 (correcto)
500 (Error del servidor)
400 (Parámetros no válidos)
401 (No autorizado)
403 (Solicitud no válida)
404 (No encontrado)
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"
}
Muestra de error de respuesta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid machine_id"
}
]
}
La descripción puede incluir
Usuario no válido
Id_máquina inválido
Nombre de usuario no válido
host_machine_id o nombre_usuario inválidos