RemotePCエンタープライズAPIはリクエストを受け付け、レスポンスを「JSON」形式で返します。API認証にはAPIキー認証機構とIPホワイトリストを使用します。すべてのAPIで、APIキーを認証ヘッダーに追加する必要があります。
APIリクエストは、ウェブコンソールで生成されたAPIキーを使用して送信できます。
APIキーの取得方法：
- RemotePCエンタープライズアカウントにログインします。
- マイアカウントタブに移動し、APIキーをクリックします。
- 表示をクリックし、アカウントパスワードを入力して表示をクリックします。
- APIキーが表示されます。キーをコピーをクリックしてクリップボードにコピーします。
APIキーを変更するには、変更をクリックします。アカウントパスワードを入力し、表示をクリックして新しいAPIキーを表示します。
注意: APIキーは管理者（アカウント所有者）のみが生成できます。
1. ユーザー招待
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
メソッドタイプ: POST
リクエストヘッダー:
- Authorization: Bearer <api key>
- Content-type: application/json
リクエスト
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)
注記: SSO をユーザーに有効化するには、まず管理者アカウントで設定する必要があります。 管理者アカウントで SSO が設定されていない場合、どのユーザーに対しても SSO を有効にすることはできません。
Http response
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
リクエストサンプル 1
{
"email": [
"shane@myworld"
]
}
リクエストサンプル 2
{
"email": [
"shane@myworld"
],
"status_2FA":1,
"sso_flag":1
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
レスポンスエラーサンプル
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
説明に含まれる場合があります
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status
2. ユーザー作成
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
リクエスト
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)
注記: SSO をユーザーに対して有効にするには、まず管理者アカウントで SSO を設定する必要があります。 管理者アカウントで SSO が設定されていない場合、どのユーザーに対しても SSO を有効にすることはできません。
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
リクエストサンプル 1
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
リクエストサンプル 2
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1,
"sso_flag":1
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
説明に含まれる場合があります
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. ユーザーの削除
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
リクエスト
string[]: sub_ids - Mandatory
string[]: invited_ids - Mandatory
sub_ids: Active User Email IDs,
invited_ids: Invited User Email IDs
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
レスポンスサンプル
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
レスポンスエラーサンプル
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
説明に含まれる場合があります
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
4. ユーザー取得
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
リクエスト
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"pageIndex": 1,
"recordPerPage": 30
}
レスポンスサンプル
{
"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"
]
}
}
}
Expected error sample
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
説明に含まれる場合があります
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
注記: 一度にリクエストできるユーザーリストの最大数は 500 件です。
5. ユーザーへのコンピューター割り当て
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
リクエスト
string: username - Mandatory
string[]: computer_names - Mandatory
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
説明に含まれる場合があります
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. ユーザーからコンピューターの割り当て解除
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
リクエスト
string: username - Mandatory
string[]: computer_names - Mandatory
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
説明に含まれる場合があります
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. グループ作成とコンピューター移動
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
リクエスト
string: group_name - Mandatory
string[]: computer_names - Optional
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
説明に含まれる場合があります
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
コンピューター削除
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
リクエスト
string[]: computer_names - Mandatory
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"computer_names": [
"Computer A",
"Computer B"
],
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
説明に含まれる場合があります
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
注記: オフラインのコンピューターのみ削除できます。 一度に削除できるコンピューターは最大 50 台です。
9. コンピューターへのコメント追加
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Request:
string: computer_name - Mandatory
string: comment_desc - Mandatory
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
説明に含まれる場合があります
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. デバイス取得
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Request:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"pageIndex": 1,
"recordPerPage": 30
}
レスポンスサンプル
{
"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
}
}
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
説明に含まれる場合があります
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
注記: 一度にリクエストできるデバイスリストの最大数は 500 件です。
11. ユーザーのデバイス取得
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Request:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"pageIndex": 1,
"recordPerPage": 30,
}
レスポンスサンプル
{
"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
}
}
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
説明に含まれる場合があります
Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
注記: The maximum number of device lists to request at once is 500.
12. コンピューターをグループへ移動
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
Request:
string: group_name- Mandatory
string[]: computer_names- Mandatory
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
予期されるエラー応答
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ビューアー接続URL取得
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
Request:
string: machine_id - Mandatory
string: username - Mandatory
HTTPレスポンス
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
レスポンスサンプル
{
"username": "abc@xyz",
"machine_id": "GVHR654GBUYJH"
}
レスポンスサンプル
{
"status": "OK",
"code": 200,
"message": "https://login.remotepc.com/rpcnew/viewer/redirect/msp/connect/process/abc"
}
レスポンスエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid machine_id"
}
]
}
説明に含まれる場合があります
Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username