RemotePC Enterprise API menerima permintaan dan mengembalikan respons dalam format 'JSON'. Mekanisme Otentikasi Kunci API digunakan bersama dengan daftar putih IP untuk mengotentikasi API. Untuk semua API, Kunci API harus ditambahkan di header otorisasi.
Anda dapat mengirim permintaan API menggunakan Kunci API yang dibuat untuk akun Anda di konsol web.
Untuk mendapatkan kunci API,
- Masuk ke RemotePC Anda Akun perusahaan.
- Pergi ke Akun Saya tab dan klik Kunci API.
- Klik Lihat, masukkan kata sandi akun, dan klik Lihat.
- Kunci API akan ditampilkan. Klik Salin Kunci untuk menyalin ke papan klip.
Untuk mengubah Kunci API, klik Ubah. Masukkan kata sandi akun dan klik Lihat untuk melihat kunci API baru.
Catatan: Hanya Admin (pemilik akun) yang dapat menghasilkan Kunci API.
1. Undang pengguna
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan
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)
Catatan: SSO harus dikonfigurasi pada akun Administrator terlebih dahulu untuk mengaktifkannya bagi pengguna. Jika SSO tidak disiapkan pada akun Administrator, itu tidak dapat diaktifkan untuk pengguna mana pun.
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Minta sampel 1
{
"email": [
"shane@myworld"
]
}
Minta sampel 2
{
"email": [
"shane@myworld"
],
"status_2FA":1,
"sso_flag":1
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Contoh kesalahan respons
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Deskripsi dapat mencakup
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status
2. Buat pengguna
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan
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)
Catatan: SSO harus dikonfigurasi pada akun Administrator terlebih dahulu untuk mengaktifkannya bagi pengguna. Jika SSO tidak disiapkan pada akun Administrator, itu tidak dapat diaktifkan untuk pengguna mana pun.
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Minta sampel 1
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Minta sampel 2
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1,
"sso_flag":1
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
Deskripsi dapat mencakup
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. Hapus pengguna
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan
string[]: sub_ids - Mandatory
string[]: invited_ids - Mandatory
sub_ids: Active User Email IDs,
invited_ids: Invited User Email IDs
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Minta sampel
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Contoh kesalahan respons
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Deskripsi dapat mencakup
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
4. Dapatkan pengguna
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"pageIndex": 1,
"recordPerPage": 30
}
Contoh tanggapan
{
"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"
]
}
}
}
Contoh kesalahan yang diharapkan
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Deskripsi dapat mencakup
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Catatan: Jumlah maksimum daftar pengguna yang dapat diminta sekaligus adalah 500.
5. Tugas komputer kepada pengguna
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan
string: username - Mandatory
string[]: computer_names - Mandatory
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Deskripsi dapat mencakup
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. Batalkan penugasan komputer ke pengguna
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan
string: username - Mandatory
string[]: computer_names - Mandatory
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Deskripsi dapat mencakup
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. Buat grup dan pindahkan komputer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan
string: group_name - Mandatory
string[]: computer_names - Optional
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
Deskripsi dapat mencakup
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. Lepaskan komputer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan
string[]: computer_names - Mandatory
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Deskripsi dapat mencakup:
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
Catatan: Hanya komputer yang offline yang dapat dihapus. Dalam satu waktu, hingga 50 komputer dapat dihapus.
9. Tambahkan komentar untuk komputer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan:
string: computer_name - Mandatory
string: comment_desc - Mandatory
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Deskripsi dapat mencakup
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. Dapatkan perangkat
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"pageIndex": 1,
"recordPerPage": 30
}
Contoh tanggapan
{
"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
}
}
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Deskripsi dapat mencakup
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Catatan: Jumlah maksimum daftar perangkat yang dapat diminta sekaligus adalah 500.
11. Dapatkan perangkat pengguna
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Permintaan:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"pageIndex": 1,
"recordPerPage": 30,
}
Contoh tanggapan
{
"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
}
}
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Deskripsi dapat mencakup
Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Catatan: Jumlah maksimum daftar perangkat yang dapat diminta sekaligus adalah 500.
12. Pindahkan komputer ke dalam grup
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
Permintaan:
string: group_name- Mandatory
string[]: computer_names- Mandatory
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Respon kesalahan yang diharapkan
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. Dapatkan URL Koneksi Penampil 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
Permintaan:
string: machine_id - Mandatory
string: username - Mandatory
Respons HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Minta sampel
{
"username": "abc@xyz",
"machine_id": "GVHR654GBUYJH"
}
Contoh tanggapan
{
"status": "OK",
"code": 200,
"message": "https://login.remotepc.com/rpcnew/viewer/redirect/msp/connect/process/abc"
}
Contoh kesalahan respons
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid machine_id"
}
]
}
Deskripsi dapat mencakup
Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username