RemotePC Enterprise API, istekleri kabul eder ve yanıtları 'JSON' formatında döndürür. API'leri doğrulamak için IP beyaz listeleme ile birlikte API Anahtarı Kimlik Doğrulama mekanizması kullanılır. Tüm API'ler için, API Anahtarı yetkilendirme başlığına eklenmelidir.
API isteklerini, web konsolunda hesabınız için oluşturulan API Anahtarı ile gönderebilirsiniz.
API anahtarını almak için,
- Kendi RemotePC hesabınıza giriş yapın Kurumsal hesap.
- Git Hesabım sekme ve tıklama API Anahtarları.
- Tıkla Görünüm, hesap şifresini girin ve tıklayın Görünüm.
- API Anahtarı görüntülenecektir. Tıklayın Anahtarı Kopyala panoya kopyalamak.
API Anahtarını değiştirmek için tıklayın Değiştir. Hesap şifresini girin ve tıklayın Görünüm yeni API anahtarını görüntülemek için.
Not: Yalnızca Yönetici (hesap sahibi) API Anahtarını oluşturabilir.
1. Kullanıcıyı davet et
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep
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)
Not: SSO kullanıcılar için etkinleştirilmeden önce Yönetici hesabında yapılandırılmalıdır. Eğer SSO Yönetici hesabında kurulmamışsa, herhangi bir kullanıcı için etkinleştirilemez.
Http yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Örnek talebi 1
{
"email": [
"shane@myworld"
]
}
Örnek talebi 2
{
"email": [
"shane@myworld"
],
"status_2FA":1,
"sso_flag":1
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Yanıt hata örneği
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Açıklama şunları içerebilir
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status
2. Kullanıcı oluştur
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep
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)
Not: SSO kullanıcılar için etkinleştirilmeden önce Yönetici hesabında yapılandırılmalıdır. Eğer SSO Yönetici hesabında kurulmamışsa, herhangi bir kullanıcı için etkinleştirilemez.
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Örnek talebi 1
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Örnek talebi 2
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1,
"sso_flag":1
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
Açıklama şunları içerebilir
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. Kullanıcıyı sil
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep
string[]: sub_ids - Mandatory
string[]: invited_ids - Mandatory
sub_ids: Active User Email IDs,
invited_ids: Invited User Email IDs
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Numune talep et
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Yanıt hata örneği
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Açıklama şunları içerebilir
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
4. Kullanıcıları al
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"pageIndex": 1,
"recordPerPage": 30
}
Yanıt örneği
{
"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"
]
}
}
}
Beklenen hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Açıklama şunları içerebilir
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Not: Aynı anda talep edilebilecek kullanıcı listelerinin maksimum sayısı 500'dür.
5. Bilgisayarı kullanıcıya ata
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep
string: username - Mandatory
string[]: computer_names - Mandatory
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Açıklama şunları içerebilir
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. Bilgisayarı kullanıcıdan kaldır
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep
string: username - Mandatory
string[]: computer_names - Mandatory
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Açıklama şunları içerebilir
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. Grup oluşturun ve bilgisayarları taşıyın
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep
string: group_name - Mandatory
string[]: computer_names - Optional
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
Açıklama şunları içerebilir
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. Bilgisayarı(ları) çıkar
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep
string[]: computer_names - Mandatory
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Açıklama şunları içerebilir:
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
Not: Yalnızca çevrimdışı bilgisayarlar kaldırılabilir. Aynı anda en fazla 50 bilgisayar kaldırılabilir.
9. Bilgisayar için yorum ekle
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep:
string: computer_name - Mandatory
string: comment_desc - Mandatory
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Açıklama şunları içerebilir
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. Cihazları al
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"pageIndex": 1,
"recordPerPage": 30
}
Yanıt örneği
{
"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
}
}
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Açıklama şunları içerebilir
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Not: Aynı anda talep edilebilecek cihaz listesi sayısının maksimumu 500'dür.
11. Kullanıcı cihazlarını al
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Talep:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"pageIndex": 1,
"recordPerPage": 30,
}
Yanıt örneği
{
"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
}
}
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Açıklama şunları içerebilir
Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Not: Aynı anda talep edilebilecek cihaz listesi sayısının maksimumu 500'dür.
12. Bilgisayarları bir gruba taşı
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
Talep:
string: group_name- Mandatory
string[]: computer_names- Mandatory
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Beklenen hata yanıtı
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. Web Görüntüleyici Bağlantı URL'sini Al
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
Talep:
string: machine_id - Mandatory
string: username - Mandatory
HTTP yanıtı
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Numune talep et
{
"username": "abc@xyz",
"machine_id": "GVHR654GBUYJH"
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "https://login.remotepc.com/rpcnew/viewer/redirect/msp/connect/process/abc"
}
Yanıt hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid machine_id"
}
]
}
Açıklama şunları içerebilir
Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username