Markdownで表示

ReviewerLaunch

POST/v2/reviewer/launch
ベース URL
https://us1.proctorapi.com
利用可能なリージョン10 リージョン
レビュアー URL を作成します。
application/json

Body

レビュアー URL を作成するためのレビュアーリクエスト。

expire
integer(int32)
レビュアー URL が無効になるまでの秒数。このパラメータのデフォルト値は 3600 秒です。値が渡されない場合、デフォルト値が適用されます。整数値である必要があります。
Minimum value is 1, Maximum value is 3600.
behavior_settings
object
表示 2 behavior_settings 属性非表示 behavior_settings 属性
frame_metrics
object
表示 8 frame_metrics 属性非表示 frame_metrics 属性
navigating_away
object
このフレームメトリックの重みに応じて、受験者が試験ページを離れた場合にProctorioがフラグを立てます。
Minimum value is 0, Maximum value is 5.
keystrokes
object
このフレームメトリックの重みに応じて、受験者が試験ウィンドウ内でタイピングした場合にProctorioがフラグを立てます。
Minimum value is 0, Maximum value is 5.
copy_paste
object
このフレームメトリックの重みに応じて、受験者が試験ウィンドウ内でコピー、カット、またはペーストを行った場合にProctorioがフラグを立てます。
Minimum value is 0, Maximum value is 5.
browser_resize
object
このフレームメトリックの重みに応じて、受験者が試験中にブラウザのサイズを変更した場合にProctorioがフラグを立てます。
Minimum value is 0, Maximum value is 5.
audio_levels
object
このフレームメトリックの重みに応じて、周囲の騒音が試験環境のホワイトノイズを超えるレベルに達した場合にProctorioがフラグを立てます。
Minimum value is 0, Maximum value is 5.
head_movement
object
このフレームメトリックの重みに応じて、受験者が試験ウィンドウから頭を動かした場合にProctorioがフラグを立てます。
Minimum value is 0, Maximum value is 5.
multiple_faces
object
このフレームメトリックの重みに応じて、複数の人が試験を見ている場合にProctorioがフラグを立てます。
Minimum value is 0, Maximum value is 5.
leaving_room
object
このフレームメトリックの重みに応じて、20〜30秒間キーボードやマウスの操作がなく、ビデオフィードに顔がはっきりと映っていない受験者にProctorioがフラグを立てます。
Minimum value is 0, Maximum value is 5.
exam_metrics
object
表示 14 exam_metrics 属性非表示 exam_metrics 属性
navigating_away
boolean
異常な回数のページ離脱は、外部のアプリケーションや資料をグループの他の受験者と異なる方法で使用している受験者を強調表示します。
keystrokes
boolean
異常なキーストローク数は、コピー&ペーストに頼っている、または自由記述問題に苦労している受験者を強調表示します。
copy_paste
boolean
異常なコピー/ペースト回数は、試験から資料を持ち出したり、繰り返し試験に回答を持ち込んだ可能性のある受験者を強調表示します。
browser_resize
boolean
異常なブラウザリサイズの回数は、試験ウィンドウの背後にメモやその他の資料を隠していた可能性のある受験者を強調表示します。
audio_levels
boolean
異常な音声レベルの変化は、試験全体を通じて音声活動に著しい変化があった受験者を強調表示します。
head_movement
boolean
異常な頭部の動きの回数は、グループの他の受験者と比べてカメラから著しく多く、または著しく少なく目を離した受験者を強調表示します。
multiple_faces
boolean
異常な検出顔数は、試験中に誰かから助けを受けた可能性のある受験者を強調表示します。
mouse_movement
boolean
異常なマウス移動の回数は、グループの他の受験者と比べて試験ページとのインタラクションが少なかった受験者を強調表示します。
scrolling
boolean
異常なスクロールの回数は、グループの他の受験者と比べて試験ページとのインタラクションが少なかった受験者を強調表示します。
clicking
boolean
異常なクリックの回数は、グループの他の受験者と比べて試験ページとのインタラクションが少なかった受験者を強調表示します。
exam_duration
boolean
異常な試験時間は、グループの他の受験者と比べて著しく速く、または著しく遅く終了した受験者を強調表示します。
start_time
boolean
開始時刻は、LMSの開始時刻がProctorioの開始時刻と一致しない受験者を強調表示します。
end_time
boolean
終了時刻は、LMSの終了時刻がProctorioの終了時刻と一致しない受験者を強調表示します。
exam_collusion
boolean
試験共謀は、同じネットワーク上で同時に試験を受けた受験者を強調表示します。
exam_settings
object必須
表示 30 exam_settings 属性非表示 exam_settings 属性
record_video
boolean
受験者にウェブカメラを要求し、試験の全期間にわたってビデオを録画します。
record_audio
boolean
受験者にマイクを要求し、試験の全期間にわたって音声を録音します。
record_screen
boolean
試験の全期間にわたってデスクトップ画面全体をキャプチャして録画します。
record_web_traffic
boolean
試験中にアクセスしたウェブサイトのスクリーンショットと URL をキャプチャします。
record_desk
integer(int32)

0 - 設定はオフです。

1 - 受験者に試験中に定期的にデスクスキャンを行うことを要求します。最初のスキャンは試験開始時に行われます。その後のスキャンは、前回から通常30〜45分の間隔で定期的にトリガーされます。以下の設定を true に設定する必要があります: record_video、verify_video。

2 - 受験者に試験開始時にデスクスキャンを行うことを要求します。以下の設定を true に設定する必要があります: record_video、verify_video。

Values are 0, 1, 2.
verify_video
boolean
ウェブカメラが動作しており、仮想化または故障していないことを確認します。以下の設定を true に設定する必要があります: record_video。
verify_audio
boolean
マイクが動作しており、仮想化またはミュートされていないことを確認します。以下の設定を true に設定する必要があります: record_audio。
verify_desktop
boolean
デスクトップ録画が動作しており、正しく録画されていることを確認します。以下の設定を true に設定する必要があります: record_screen。
verify_id
integer(int32)

0 - 設定はオフです。

1 - 受験者に試験開始前に写真付き身分証明書の提示を要求し、自動的にスキャンされます。

2 - 受験者に試験開始前に写真付き身分証明書の提示を要求します。その後、身分証明書は Proctorio のエージェントによって確認・検証され、試験への参加が許可されます。以下の設定を true に設定する必要があります: record_video、verify_video。

Values are 0, 1, 2.
verify_signature
boolean
受験者に試験開始前に同意書への署名を要求します。
full_screen
integer(int32)

0 - 設定はオフです。

1 - 試験をフルスクリーンで強制し、他のアプリケーションやウェブサイトへのアクセスを防ぎます。試験ページから累計15秒以上離れると、試験から退出させられます。以下の設定を true に設定する必要があります: close_tabs、one_screen。tabs の値が 1 である必要があります。

2 - 試験をフルスクリーンで強制し、他のアプリケーションやウェブサイトへのアクセスを防ぎます。試験ページから累計30秒以上離れると、試験から退出させられます。以下の設定を true に設定する必要があります: close_tabs、one_screen。tabs の値が 1 である必要があります。

3 - 試験をフルスクリーンで強制し、他のアプリケーションやウェブサイトへのアクセスを防ぎます。試験ページから離れると即座に試験から退出させられます。以下の設定を true に設定する必要があります: close_tabs、one_screen。tabs の値が 1 である必要があります。

Values are 0, 1, 2, 3.
disable_clipboard
boolean
コピー/ペースト機能を無効にします。
tabs
integer(int32)

0 - 設定はオフです。

1 - 試験中に新しいタブやウィンドウを無効にします。

2 - 試験ページに埋め込まれたリンクを除き、試験中に新しいタブやウィンドウを無効にします。

Values are 0, 1, 2.
close_tabs
boolean
試験開始前に他のすべてのタブとウィンドウを閉じることを強制します。
one_screen
boolean
受験者に試験開始前にモニターを1台のみにすることを強制し、試験中に追加のモニターの接続を防ぎます。
disable_printing
boolean
試験内容の配布を防ぐため、印刷を無効にします。
block_downloads
boolean
受験者がブラウザ経由でファイルをダウンロードすることを防ぎます。
clear_cache
boolean
試験が送信された後にシステムの一時ファイルを削除します。
disable_right_click
boolean
右クリック機能を無効にします。
calculator
integer(int32)

0 - 設定はオフです。

1 - 受験者に基本的な機能を備えた画面上の電卓を提供します。

2 - 受験者に科学計算機能を備えた画面上の電卓を提供します。

3 - 受験者にグラフ機能を備えた画面上の電卓を提供します。

Values are 0, 1, 2, 3.
whiteboard
boolean
受験者に画面上のメモ帳と描画ツールを提供します。
disable_extensions
boolean
許可リストに登録されたものを除き、受験者が試験中に他のブラウザ拡張機能を使用することを防ぎます。
live_proctor
boolean
この設定により、試験監督者は試験中に受験者を監視し、即座に介入できます。また、完全な録画とレポートは Proctorio Review Center から利用可能です。以下の設定を true に設定する必要があります: record_video、verify_video。
mobile
boolean
MobileExam アプリケーションを使用して、モバイルデバイスで試験を受けることを許可します。起動リクエストで pre_auth の使用が必要です。verify_id: 2 の設定とは互換性がありません。
advanced_program_detection
boolean
試験中に他のアプリケーションの使用を防ぎます。Secure Companion アプリケーションの使用が必要です。
advanced_hardware_detection
boolean
試験中のハードウェア変更を Review Center に記録します。Secure Companion アプリケーションの使用が必要です。
advanced_vm_detection
boolean
仮想マシンを使用した試験の受験を防ぎます。Secure Companion アプリケーションの使用が必要です。
allowed_macos_apps
array[string]
advanced_program_detection 使用時に開いたままにできる許可されたアプリケーションを最大10個リストできます。MacOS ではアプリケーションは bundle ID で識別されます。
allowed_windows_apps
array[object]
advanced_program_detection 使用時に開いたままにできる許可されたアプリケーションを最大10個リストできます。Windows ではアプリケーションは binary_name、product_name、company_name で識別されます。
表示 3 allowed_windows_apps 属性非表示 allowed_windows_apps 属性
binary_name
string
アプリケーションのバイナリ名です。
product_name
string
アプリケーションの製品名です。
company_name
string
アプリケーションの会社名です。
strict_apps_validation
integer(int32)

advanced_program_detection、allowed_macos_apps、allowed_windows_apps を使用する際の許可されたアプリケーションの検証の厳密度を設定します。

0 - 設定はオフです。

1 - デフォルトの検証です。

Values are 0, 1.
record_desk_option
integer(int32)
Values are 0, 1, 2.
domain
string

"domain" パラメータはオプションです。"domain" を使用することで、試験ページおよび Reviewer Center が指定したドメインで読み込まれます。

URL は https://getproctorio.com ページを指さなくなります。代わりに、受験者/レビューアーはパラメータで指定した新しいルートに転送されます。例: https://yourdomain.com。

これにより、SameSite cookies や X-Frame-Options: SAMEORIGIN ヘッダーを使用する追加のクロスオリジンセキュリティメカニズムを利用できます。また、ストレージパーティショニングブラウザ機能に関連するセッションまたはローカルストレージのデータ損失を防ぐことができます。

https://getproctorio.com ページには以下の機能があります: 受験者/レビューアーがサポートされているブラウザをインストールしているかの確認。受験者/レビューアーが Proctorio 拡張機能をインストールしているかの確認。これらの機能を維持するには、機関のページに getproctorio.com の目的を説明するコンテンツと共に https://getproctorio.com へのリンクが必要です。

branding
object
表示 3 branding 属性非表示 branding 属性
primary_color
string
16進カラーコードは、一部のユーザーインターフェースコントロールのプライマリカラーを指定します。値は # なしの6桁のコードである必要があります。学習プラットフォームが Proctorio のカラースキームと自社のカラースキームを合わせ、ヘッダーでブランドを強調できます。文字列値である必要があります。
Format should match: ^[a-zA-Z0-9]*$.
secondary_color
string
16進カラーコードは、一部のユーザーインターフェースコントロールのセカンダリカラーを指定します。値は # なしの6桁のコードである必要があります。学習プラットフォームが Proctorio のカラースキームと自社のカラースキームを合わせ、ブランドを強調できます。文字列値である必要があります。
Format should match: ^[a-zA-Z0-9]*$.
logo_url
string
カスタムロゴのエンドポイント URL です。HTTP メソッド: GET。レスポンスは画像である必要があります。CORS セーフ。ロゴの高さは 32px で、幅は可変です。
user_id
string必須
この特定のユーザーに固有の英数字(ハイフンも許容)の値を含む必要があります。
Format should match: ^[a-zA-Z0-9-]*$.
exam_tag
string
これは試験 ID タグであり、URL の末尾に追加されます。exam_tag にはスペースを含めることができず、NON-ASCII 文字も含めることができません。使用した場合、Proctorio はそれをレスポンスに反映します。使用しない場合、ハッシュなしの URL が生成されるため、使用前に学習プラットフォームが追加する必要があります。Proctorio は exam_tag が提供されない場合に roster_url の使用を推奨します。
Format should match: ^(?!goodbye$|support$|update$|setup$|invalid$).*.
section_id
string

コース ID またはセクション ID の値を表します。このパラメータはオプションです。試験のより詳細なソートを提供します。

これは、同じ "exam_tag" でも異なる "section_id" を持つ試験が、異なる試験として扱われることを意味します。

"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 に渡す必要はありません。

レスポンス

200application/json

成功を示し、レビュアー URL を返します。

400application/json

不正なリクエストを示します。

401application/json

未承認のレスポンスを示します。

2154 - アカウントが有効ではありません。

2155 - リージョンが正しくありません。

2655 - api_key が無効です。

POST/v2/reviewer/launch
curl --request POST \
  --url https://us1.proctorapi.com/v2/reviewer/launch \
  --header 'Content-Type: application/json' \
  --header 'api_key: $API_KEY' \
  --data '{"exam_settings":{"record_video":true,"record_audio":false,"record_screen":false,"verify_video":false},"user_id":"example-id-123"}'
import requests

url = "https://us1.proctorapi.com/v2/reviewer/launch"

payload = {
    "exam_settings": {
        "record_video": True,
        "record_audio": False,
        "record_screen": False,
        "verify_video": False
    },
    "user_id": "example-id-123"
}
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/reviewer/launch';
const options = {
  method: 'POST',
  headers: {api_key: '$API_KEY', 'Content-Type': 'application/json'},
  body: '{"exam_settings":{"record_video":true,"record_audio":false,"record_screen":false,"verify_video":false},"user_id":"example-id-123"}'
};

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/reviewer/launch"),
    Headers =
    {
        { "api_key", "$API_KEY" },
    },
    Content = new StringContent("{\"exam_settings\":{\"record_video\":true,\"record_audio\":false,\"record_screen\":false,\"verify_video\":false},\"user_id\":\"example-id-123\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}
リクエスト例
{
  "exam_settings": {
    "record_video": true,
    "record_audio": false,
    "record_screen": false,
    "verify_video": false
  },
  "user_id": "example-id-123"
}