Launchpad
ベース URL
https://us1.proctorapi.com利用可能なリージョン10 リージョン
試験監督 Launchpad URL を作成します。
application/jsonBody
試験監督 Launchpad URL を作成するための試験監督リクエスト。
user_id
string必須
この特定のユーザーに固有の英数字（ハイフンも許容）の値を含む必要があります。
Format should match:
^[a-zA-Z0-9-]*$.exam_roster
string必須
試験名簿エンドポイント。exam_name、exam_tag、section_id のリストとオプションの roster_url を含みます。
roster_url
string
名簿のエンドポイント URL です。HTTP メソッド: GET。レスポンスは JSON 文字列化された配列である必要があります。例: '[["id1","name1"],["id2","name2"]]'
"id" の値は "userId" パラメータに対応し、受験者に固有で、名簿内で重複しないものである必要があります。
名簿エンドポイントは Proctorio によって検証されるため、無効なエンドポイントが提供された場合、または "userId" が配列内のいずれの "id" 値とも一致しない場合、試行は Review Center で「Unmatched」としてマークされます。
roster_url は Review Center または試験同意ページにアクセスするエンドユーザーによってクライアントサイドでフェッチされ、Proctorio が直接フェッチするものではありません。そのため、特定のユーザーのセッションで保護できます。これは意図的なものであり、受験者起動リクエストやレビューアー起動リクエストにおいて、PII を Proctorio に渡す必要はありません。
expire
integer(int32)
試験監督 URL が無効になるまでの秒数。このパラメータのデフォルト値は 3600 秒です。値が渡されない場合、デフォルト値が適用されます。整数値である必要があります。
Minimum value is
1, Maximum value is 3600.behavior_settings
object
proctor_settings
object
レスポンス200application/json成功を示し、試験監督 Launchpad URL を返します。
400application/json不正なリクエストを示します。
401application/json未承認のレスポンスを示します。
2154 - アカウントが有効ではありません。
2155 - リージョンが正しくありません。
2655 - api_key が無効です。
200application/json
成功を示し、試験監督 Launchpad URL を返します。
400application/json
不正なリクエストを示します。
401application/json
未承認のレスポンスを示します。
2154 - アカウントが有効ではありません。
2155 - リージョンが正しくありません。
2655 - api_key が無効です。
curl --request POST \
--url https://us1.proctorapi.com/v2/live/launchpad \
--header 'Content-Type: application/json' \
--header 'api_key: $API_KEY' \
--data '{"user_id":"example-id-123","exam_roster":"https://example.com/exam"}'import requests
url = "https://us1.proctorapi.com/v2/live/launchpad"
payload = {
"user_id": "example-id-123",
"exam_roster": "https://example.com/exam"
}
headers = {
"api_key": "$API_KEY",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())const fetch = require('node-fetch');
const url = 'https://us1.proctorapi.com/v2/live/launchpad';
const options = {
method: 'POST',
headers: {api_key: '$API_KEY', 'Content-Type': 'application/json'},
body: '{"user_id":"example-id-123","exam_roster":"https://example.com/exam"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://us1.proctorapi.com/v2/live/launchpad"),
Headers =
{
{ "api_key", "$API_KEY" },
},
Content = new StringContent("{\"user_id\":\"example-id-123\",\"exam_roster\":\"https://example.com/exam\"}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}{
"user_id": "example-id-123",
"exam_roster": "https://example.com/exam"
}