RemotePC Enterprise API przyjmuje żądania i zwraca odpowiedzi w formacie 'JSON'. Mechanizm uwierzytelniania za pomocą klucza API jest używany wraz z białą listą adresów IP do uwierzytelniania API. Dla wszystkich API, klucz API musi być dodany w nagłówku autoryzacji.
Możesz wysyłać żądania API, używając klucza API wygenerowanego dla Twojego konta w konsoli internetowej.
Aby uzyskać klucz API,
- Zaloguj się do swojego RemotePC Konto firmowe.
- Idź do Moje konto tab i kliknij Klucze API.
- Kliknij Widok, wprowadź hasło do konta i kliknij Widok.
- Klucz API zostanie wyświetlony. Kliknij Kopiuj klucz skopiować do schowka.
Aby zmienić klucz API, kliknij Zmień. Wprowadź hasło do konta i kliknij Widok aby wyświetlić nowy klucz API.
Uwaga: Tylko administrator (właściciel konta) może wygenerować klucz API.
1. Zaproś użytkownika
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
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)
Uwaga: SSO musi być najpierw skonfigurowany na koncie Administratora, aby można go było włączyć dla użytkowników. Jeśli SSO nie jest skonfigurowany na koncie Administratora, nie można go włączyć dla żadnego użytkownika.
Odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Prośba o próbkę 1
{
"email": [
"shane@myworld"
]
}
Poproś o próbkę 2
{
"email": [
"shane@myworld"
],
"status_2FA":1,
"sso_flag":1
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Przykład błędu odpowiedzi
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Opis może zawierać
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status
2. Utwórz użytkownika
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
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)
Uwaga: SSO musi być najpierw skonfigurowany na koncie Administratora, aby można go było włączyć dla użytkowników. Jeśli SSO nie jest skonfigurowany na koncie Administratora, nie można go włączyć dla żadnego użytkownika.
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Prośba o próbkę 1
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Poproś o próbkę 2
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1,
"sso_flag":1
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
Opis może zawierać
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. Usuń użytkownika
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
string[]: sub_ids - Mandatory
string[]: invited_ids - Mandatory
sub_ids: Active User Email IDs,
invited_ids: Invited User Email IDs
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Poproś o próbkę
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Przykład błędu odpowiedzi
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Opis może zawierać
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
4. Pobierz użytkowników
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"pageIndex": 1,
"recordPerPage": 30
}
Próbka odpowiedzi
{
"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"
]
}
}
}
Oczekiwana próbka błędu
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Opis może zawierać
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Notatka: Maksymalna liczba list użytkowników, które można zażądać jednocześnie, wynosi 500.
5. Przypisz komputer użytkownikowi
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
string: username - Mandatory
string[]: computer_names - Mandatory
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Opis może zawierać
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. Usuń przypisanie komputera do użytkownika
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
string: username - Mandatory
string[]: computer_names - Mandatory
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Opis może zawierać
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. Utwórz grupę i przenieś komputery
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
string: group_name - Mandatory
string[]: computer_names - Optional
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
Opis może zawierać
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. Usuń komputer(y)
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
string[]: computer_names - Mandatory
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Opis może zawierać:
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
Notatka: Tylko komputery offline mogą zostać usunięte. Jednocześnie można usunąć do 50 komputerów.
9. Dodaj komentarz dla komputera
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba:
string: computer_name - Mandatory
string: comment_desc - Mandatory
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Opis może zawierać
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. Pobierz urządzenia
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"pageIndex": 1,
"recordPerPage": 30
}
Próbka odpowiedzi
{
"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
}
}
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Opis może zawierać
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Notatka: Maksymalna liczba list urządzeń, które można zażądać jednocześnie, wynosi 500.
11. Pobierz urządzenia użytkowników
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"pageIndex": 1,
"recordPerPage": 30,
}
Próbka odpowiedzi
{
"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
}
}
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Opis może zawierać
Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Notatka: Maksymalna liczba list urządzeń, które można zażądać jednocześnie, wynosi 500.
12. Przenieś komputery do grupy
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
Prośba:
string: group_name- Mandatory
string[]: computer_names- Mandatory
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Oczekiwana odpowiedź błędu
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. Pobierz URL połączenia przeglądarki internetowej
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
Prośba:
string: machine_id - Mandatory
string: username - Mandatory
odpowiedź HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Poproś o próbkę
{
"username": "abc@xyz",
"machine_id": "GVHR654GBUYJH"
}
Próbka odpowiedzi
{
"status": "OK",
"code": 200,
"message": "https://login.remotepc.com/rpcnew/viewer/redirect/msp/connect/process/abc"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid machine_id"
}
]
}
Opis może zawierać
Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username