集成指南

事件和webhook

验证考试入口

您可以验证即将参加考试的受访者，还可以添加有关此用户的元数据.
当受访者要求开始考试的请求时，我们的服务器将向您的服务器URL提出Webhook请求，以验证受访者凭据（例如电子邮件，密码或矩阵NO）是否有效.
您的服务器可以可选地对此受访者进行一些元数据响应，例如 name, email, photo, about and data.
以下示例模仿对您的服务器的请求以及如果验证成功，则预期响应

请注意，您期望您在60秒内做出响应，否则请求将由我们的服务器终止.
如果您的服务器无法验证受访者，则希望您提供 errorMessage 有原因，否则您应该省略它.您可以选择提供 metadata 如果验证成功.

另外，如果您打算对受访者进行面部检测，则希望您能提供 metadata.photo 链接到受访者的尖锐图像。建议的图像分辨率是大于1500x1500像素的图像。

确保您通过检查对服务器验证所有传入请求 x-client-id and x-client-secret 在请求标题上

{
  "event": "verify_respondent",
  "fields": [
    {
      "position": 0,
      "value": "Some valid student id"
    },
    {
      "position": 1,
      "value": "Some valid student password"
    }
  ],
  "exam_id": "some unique exam_id",
  "choosenLang": "ru"
}

以下示例模仿对服务器的请求以及如果验证失败，则预期响应

{
  "event": "verify_respondent",
  "fields": [
    {
      "position": 0,
      "value": "Some invalid student id"
    },
    {
      "position": 1,
      "value": "Some invalid student password"
    }
  ],
  "exam_id": "some unique exam_id..",
  "choosenLang": "ru"
}

确保启用 validate fields via webhook 在考试创建页面中

或者，如果您使用的是开发人员API，请确保 welcomePage.validate 是真的

设置您的Webhook URL

您可以设置并更改服务器网络网址，以下是如何

导航到设置。
转到开发人员部分。
Edit and copy your webhook url

接纳受访者活动

当受访者被接受考试时，我们的服务器将通知您的服务器。下面的示例演示了这种情况

respondent_id 查找有关该受访者的其他信息

{
  "event": "admitted_respondent",
  "respondent_id": "some unique id given to the respondent",
  "exam_id": "some unique exam_id",
  "admittedOn": 1719221380326
}

结果准备事件

当准备考试的受访者结果准备就绪时，我们的服务器将通知您的服务器。下面的示例演示了这种情况

respondent_id 查找该受访者的结果数据

{
  "event": "result_ready",
  "respondent_id": "some unique id given to the respondent",
  "exam_id": "some unique exam_id"
}

调查完成事件

完成对受访者的调查完成后，我们的服务器将通知您的服务器。下面的示例演示了这种情况

respondent_id 查找有关该受访者的其他信息

{
  "event": "investigation_complete",
  "respondent_id": "some unique id given to the respondent",
  "exam_id": "some unique exam_id"
}

集成指南

事件和webhook

验证考试入口

设置您的Webhook URL

导航到设置。

转到开发人员部分。

Edit and copy your webhook url

接纳受访者活动

结果准备事件

调查完成事件

反馈评论 (0)

共享链接

集成指南