Markdownで表示

WebhooksSubscribe

POST/v2/whks/subscribe/{type}
ベース URL
https://us1.proctorapi.com
利用可能なリージョン10 リージョン
サブスクリプションリクエストは、Proctorio Webhook 通知へのサブスクリプションの開始を正式に行います。

パスパラメータ

type
string必須
1 - 疑惑計算 Webhook タイプ
application/json

Body

サブスクリプションリクエスト。

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
試験共謀は、同じネットワーク上で同時に試験を受けた受験者を強調表示します。
version
string
サブスクライブする疑惑計算 Webhook のバージョン。現在サポートされているバージョンは '2' と '3' です。
client
object必須
表示 2 client 属性非表示 client 属性
url
string必須
クライアントエンドポイント URL を表します。
key
string
Key パラメータはクライアントの API キー値を表します。このパラメータはオプションです。

レスポンス

200application/json

成功を示し、サブスクリプションレスポンスを返します。

400application/json

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

401application/json

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

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

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

2655 - api_key が無効です。

POST/v2/whks/subscribe/{type}
curl --request POST \
  --url https://us1.proctorapi.com/v2/whks/subscribe/%7Btype%7D \
  --header 'Content-Type: application/json' \
  --header 'api_key: $API_KEY' \
  --data '{"client":{"url":"https://example.com","key":"string"}}'
import requests

url = "https://us1.proctorapi.com/v2/whks/subscribe/%7Btype%7D"

payload = { "client": {
        "url": "https://example.com",
        "key": "string"
    } }
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/whks/subscribe/%7Btype%7D';
const options = {
  method: 'POST',
  headers: {api_key: '$API_KEY', 'Content-Type': 'application/json'},
  body: '{"client":{"url":"https://example.com","key":"string"}}'
};

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/whks/subscribe/%7Btype%7D"),
    Headers =
    {
        { "api_key", "$API_KEY" },
    },
    Content = new StringContent("{\"client\":{\"url\":\"https://example.com\",\"key\":\"string\"}}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}
リクエスト例
{
  "client": {
    "url": "https://example.com",
    "key": "string"
  }
}