RemotePC APIはリクエストを受け付け、レスポンスを「JSON」形式で返す。APIを認証するために、IPホワイトリストとともにAPIキー認証メカニズムが使用される。すべてのAPIについて、API Keyをauthorizationヘッダーに追加する必要があります。
再販業者は、ウェブコンソールでアカウント用に生成されたAPIキーを使用してAPIリクエストを送信できます。
APIキーを取得する、
- RemotePC Resellerアカウントにログインします。
- マイアカウント]タブに移動し、[APIキー]をクリックします。
- 表示」をクリックし、アカウントのパスワードを入力して「表示」をクリックします。
- APIキーが表示されます。Copy Keyをクリックしてクリップボードにコピーします。
APIキーを変更するには、Changeをクリックします。アカウントのパスワードを入力し、[View]をクリックして新しいAPIキーを表示します。
1.ユーザーを追加する
URL：https://web1.remotepc.com/rpc-api/reseller/private/user/add
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
文字列 firstName；
文字列 lastName；
文字列 invitedUserEmailId；
文字列パスワード
integer allotedComputers;//オプションのパラメータ、デフォルトは 0
boolean sendEmailToUser;//ユーザーへのメール通知はオプションのパラメータです。
HTTPレスポンスコード
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
サンプル請求
{
"firstName": "firstname",
"lastName": "lastname",
"invitedUserEmailId": "shane@idrive.com",
"password": "password",
"allotedComputers": 1,
"sendEmailToUser": true
}
応答
応答成功サンプル
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
応答エラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "EMAIL_EXISTS"
}
]
}
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
{
"status": "Forbidden",
"code": 403,
"errorsCount": 1,
"errors": [
{
"description": "Forbidden "
}
]
}
説明には以下が含まれる：
- firstname_required、
- lastname_required、
- emailid_required、
- enter_valid_email、
- password_required、
- 無効パスワード
2.ユーザーを招待する
URL：https://web1.remotepc.com/rpc-api/reseller/private/user/invite
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
文字列 invitedUserEmailId；
integer allotedComputers;//オプションのパラメータ、デフォルトは 0
HTTPレスポンスコード
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
サンプル請求
[
{
"invitedUserEmailId": "shane@idrive.com",
"allotedComputers": 10
}
]
応答成功サンプル
{
"status": "OK",
"code": 200,
"message": [
{
"username": "shane@idrive.com",
"status": "ALREADY_INVITED"
},
{
"username": "shane@idrive.com",
"status": "EXISTS"
},
{
"username": "shane@idrive.com",
"status": "INVITED"
}
]
}
応答エラーサンプル
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
{
"status": "Forbidden",
"code": 403,
"errorsCount": 1,
"errors": [
{
"description": "Forbidden "
}
]
}
3.ユーザーサインイン
URL：https://web1.remotepc.com/rpc-api/reseller/private/user/signin
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
リクエスト
文字列ユーザー名
文字列パスワード
HTTPレスポンスコード
200（成功）
500（サーバーエラー）
400（無効なパラメータ）
401（認証されていません）
403（無効なリクエスト）
サンプル請求
{
"username": "username",
"password": "password"
}
応答
応答成功サンプル
{
"status": "OK",
"code": 200,
"message": {
"rpc_redirect_link":"https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9"
}
}
注：アカウントへの自動ログインにはrpc_redirect_linkを使用する。
応答エラーサンプル
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "USERNAME_DOES_NOT_EXIST"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "ACTION_PARENT_ACCOUNT_SUSPENDED"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "IP_ADDRESS_BLOCKED"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "CANCELLED_ACCOUNT"
}
]
}
説明には以下が含まれる。
emailid_required、
INVALID_EMAIL、
password_required、
ユーザー名
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
4.ユーザーリスト
URL:https://web1.remotepc.com/rpc-api/reseller/private/user/list
メソッドタイプ： ポスト
リクエストヘッダ：
- Authorization: Bearer <api key>
- コンテンツタイプ: application/json
HTTPレスポンスコード
200（成功）
500（サーバーエラー）
401（認証されていません）
応答
応答成功サンプル
{
"status": "OK",
"code": 200,
"message":{
"resellerUsersList": [
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
},
{
"alloted_computers": 425,
"created_date": "01-25-2023",
"isActive": true,
"utilized_computers": 0,
"username": "shane@idrive.com"
}
]
}
}
応答エラーサンプル
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "UNAUTHORIZED_ACCESS"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}