RemotePC Enterprise API は、「JSON」形式で要求を受け付け、応答を返します。API キー認証メカニズムは、API を認証するために IP ホワイトリストと共に使用されます。すべてのAPIについて、API Keyをauthorizationヘッダーに追加する必要があります。
ウェブ・コンソールでアカウント用に生成されたAPIキーを使用して、APIリクエストを送信できます。
APIキーを取得するには
- RemotePCEnterpriseアカウントにログインします。
- マイアカウント]タブに移動し、[APIキー]をクリックします。
- 表示」をクリックし、アカウントのパスワードを入力して「表示」をクリックします。
- APIキーが表示されます。Copy Keyをクリックしてクリップボードにコピーします。
APIキーを変更するには、Changeをクリックします。アカウントのパスワードを入力し、[View]をクリックして新しいAPIキーを表示します。
注意：API Keyを生成できるのは管理者（アカウント所有者）のみです。
1.ユーザーを招待する
URL：https://web1.remotepc.com/rpcnew/api/msp/user/invite
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string[]: email - 必須
int: status_2FA - オプション (指定可能な値は 0 と 1; 1 - ステータス ON & 0 - ステータス OFF)
int: sso_flag - オプション(許可される値は 0 と 1; 1 - SSO を有効にする & 0 - SSO を無効にする)
注：SSOをユーザーに有効にするには、まず管理者アカウントでSSOを設定する必要があります。SSOが管理者アカウントで設定されていない場合、どのユーザーでも有効にすることはできません。
Httpレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
サンプル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"
}
]
}
説明には以下が含まれる。
失敗
内部サーバーエラー
無効なユーザー
無効なユーザー権限
無効なユーザープラン
無効な2要素ステータス
2.ユーザー作成
URL：https://web1.remotepc.com/rpcnew/api/msp/user/create
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string: firstname - 必須
string: lastname - 必須
string: ユーザ名 - 必須
string: パスワード - 必須
int: status_2FA - オプション (指定可能な値は 0 と 1; 1 - ステータスが有効 & 0 - ステータスが無効)
int: sso_flag - オプション (指定可能な値は 0 と 1; 1 - SSO を有効にする & 0 - SSO を無効にする)
注：SSOをユーザーに有効にするには、まず管理者アカウントでSSOを設定する必要があります。SSOが管理者アカウントで設定されていない場合、どのユーザーでも有効にすることはできません。
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
サンプル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
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string[]: sub_ids - 必須
string[]: invited_ids - 必須
sub_ids：アクティブユーザーのメールID、
invited_ids：招待されたユーザーの電子メールID
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる。
失敗
内部サーバーエラー
無効なユーザー
無効なユーザー権限
無効なユーザープラン
4.ユーザーを獲得する
URL：https://web1.remotepc.com/rpcnew/api/msp/user/list
メソッドタイプ： ゲット
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
Int pageIndex - オプション．
Int recordPerPage - オプション．
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
]
}
}
}
予想されるエラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
説明には以下が含まれる。
無効なユーザー
無効なユーザー権限
内部サーバーエラー
無効なユーザープラン
無効なページインデックス
注：一度にリクエストできるユーザーリストの最大数は500です。
5.ユーザーにコンピュータを割り当てる
URL：https://web1.remotepc.com/rpcnew/api/msp/computer/assign
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string: ユーザ名 - 必須
string[]: コンピュータ名 - 必須
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる。
ユーザー名が必要です
コンピュータ名がリクエストに見つかりません
ユーザーが見つかりません
コンピュータが見つかりません
無効なユーザー
無効なユーザー権限
インターナル・サーバー・エラー
無効なユーザープラン
6.コンピュータの割り当てを解除する
URL：https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string: ユーザ名 - 必須
string[]: コンピュータ名 - 必須
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる。
ユーザー名が必要です
コンピュータ名がリクエストに見つかりません
ユーザーが見つかりません
コンピュータが見つかりません
無効なユーザー
無効なユーザー権限
インターナル・サーバー・エラー
無効なユーザープラン
7.グループの作成とコンピュータの移動
URL：https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string: group_name - 必須
string[]: コンピュータ名 - オプション
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる。
ユーザー名が必要です
コンピュータ名がリクエストに見つからない
無効なユーザー
無効なユーザー権限
インターナル・サーバー・エラー
無効なユーザープラン
グループ名は空白にできません
グループ名がすでに存在する
無効なグループ名
8.コンピュータを取り外す
URL：https://web1.remotepc.com/rpcnew/api/msp/computer/remove
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string[]: コンピューター名 - 必須
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる：
無効なユーザー
コンピュータ名がリクエストに見つかりません
コンピュータの上限を超えています
コンピュータが見つかりません
無効なユーザー権限
インターナル・サーバー・エラー
無効なユーザプラン
注：削除できるのはオフラインコンピュータのみです。一度に最大50台のコンピュータを削除できます。
9.コンピュータのコメントを追加
URL：https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string: コンピュータ名 - 必須
string: comment_desc - 必須
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる。
ユーザー名は必須
コンピュータ名は空白にできません
コメントは空白にできません
コメントの長さは6～250です
コンピュータが見つかりません
無効なユーザー
無効なユーザー権限
インターナル・サーバー・エラー
無効なユーザープラン
10.デバイスの入手
URL：https://web1.remotepc.com/rpcnew/api/msp/computer/list
メソッドタイプ： ゲット
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
Int pageIndex - オプション．
Int recordPerPage - オプション．
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる。
無効なユーザー
無効なユーザー権限
内部サーバーエラー
無効なユーザープラン
無効なページインデックス
注：一度にリクエストできるデバイスリストの最大数は500です。
11.ユーザーデバイスの取得
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
メソッドタイプ： ゲット
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
Int pageIndex - オプション．
Int recordPerPage - オプション．
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる。
無効なユーザー
無効なユーザー名
無効なユーザー権限
内部サーバーエラー
無効なユーザープラン
無効なページインデックス
注：一度にリクエストできるデバイスリストの最大数は500です。
12.コンピュータをグループに移動する
URL：https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization header: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string:グループ名 - 必須
string[]:computer_names- 必須
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
期待されるエラー・レスポンス
コンピュータ名がリクエストに見つからない
無効なユーザー
無効なユーザー権限
インターナル・サーバー・エラー
無効なユーザープラン
グループ名は空白にできません
グループ名が存在しない
無効なグループ名
13.Webビューア接続URLの取得
URL：https://web1.remotepc.com/rpcnew/api/msp/computer/get/connectUrl
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization header: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
string:machine_id - 必須
string:username - 必須
HTTPレスポンス
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
404（見つかりません）
サンプル請求
{
"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"
}
]
}
説明には以下が含まれる。
無効なユーザー
無効なマシンID
無効なユーザ名
無効な host_machine_id または username