Интеграция на основе SDK

1. Сценарий прокторинга

2. Интеграция SDK

2.1 Стандарт JSON Web Token (RFC 7519)

2.2 Формирование токена

<!--JWT payload-->

{
  "username": "a34c1a1a-53ef-4728-8dc5-9c4779a8586e",
  "nickname": "John Doe",
  "identifier": "565b30b8-5cfb-42e2-a292-478d20630d1b",
  "template": "default",
  "subject": "Tutorial: proctoring",
  "tags": [ "male" ]
}

<!--Token-->

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImEzNGMxYTFhLTUzZWYtNDcyOC04ZGM1LTljNDc3OWE4NTg2ZSIsIm5pY2tuYW1lIjoiSm9obiBEb2UiLCJpZGVudGlmaWVyIjoiNTY1YjMwYjgtNWNmYi00MmUyLWEyOTItNDc4ZDIwNjMwZDFiIiwidGVtcGxhdGUiOiJkZWZhdWx0Iiwic3ViamVjdCI6IlR1dG9yaWFsOiBwcm9jdG9yaW5nIiwidGFncyI6WyJtYWxlIl19.1sHajdMz3n82hQEsfJTE3bii6mV3nOtTLkxTe6qwzuI

Валидация токена

Параметры профиля пользователя

Параметры сеанса прокторинга

2.3 Инициализация сеанса

<!--HTML-->

<script src="//demo.proctoring.online/sdk/supervisor.js"></script>
<script>
  // создать экземпляр класса Supervisor
  var supervisor = new Supervisor({
    url: 'https://demo.proctoring.online'
  });
  // инициализация сессии прокторинга
  // в поле token можно указать строку, функцию или промис
  supervisor.init({
    // указать провайдер авторизации, по умолчанию 'jwt'
    provider: 'jwt',
    // получить строку с токеном JWT от вашего сервера
    // на стороне вашего сервера должен быть реализован API
    token: fetch('/api/token').then(function(response) {
      if (response.ok) return response.text();
      else throw Error('Failed to get JWT');
    })
  }).then(function() {
    // запустить сессию прокторинга сразу после инициализации
    return supervisor.start();
  }).then(function() {
    // запустить тест в системе тестирования
  }).catch(function(err) {
    // в случае ошибки отобразить соответствующее сообщение
    alert(err.toString());
    // выполнить переадресацию на главную страницу,
    // чтобы не дать начать тест без прокторинга
    location.href = '/';
  });
</script>

2.4 Запуск сеанса

<!--HTML-->

<script>
  // подписаться на событие запуска сеанса
  supervisor.on('start', function() {
    console.log('started');
  });
</script>

2.5 Завершение сеанса

<!--HTML-->

<script>
  // завершить сеанс прокторинга
  supervisor.stop()
    .then(function() {
      // разлогиниться на сервере
      return supervisor.logout();
  });
</script>

<!--HTML-->

<script>
  // подписаться на событие завершения сеанса
  supervisor.on('stop', function() {
    console.log('stopped');
  });
</script>

2.6 Ссылки на основе токена

<!--URL-->

https://demo.proctoring.online/api/auth/jwt?token=<JWT>

<!--HTTP Header-->

Set-Cookie: <cookie-name>=<cookie-value>; SameSite=None; Secure
Content-Security-Policy: frame-src https://*.proctoring.online

2.7 Data-атрибуты для автоматической инициализации

<!--HTML-->

<script src="https://demo.proctoring.online/sdk/supervisor.js" data-supervisor="start"></script>

<!--HTML-->

<script src="https://demo.proctoring.online/sdk/supervisor.js" data-supervisor="init"></script>

<!--HTML-->

<script src="https://demo.proctoring.online/sdk/supervisor.js" data-supervisor="start" data-provider="signup"></script>

3. Наблюдение и доступ к протоколам для прокторов

<!--URL-->

https://demo.proctoring.online/api/report/<identifier>

<!--JWT payload-->

{
  "username": "proctor1",
  "role": "proctor"
}

<!--URL-->

https://demo.proctoring.online/api/auth/jwt?token=<JWT>

4. Получение результатов прокторинга

5. Настройка интеграции в системе прокторинга

<!--JSON-->

{
  "id": "<Host_ID>",
  "key": "<License_Key>",
  "params": {
    "webhooks": {
      "sdk": {
        "authorizer": "jwt",
        "integrator": "generic",
        "secretOrKey": "secret",
        "callbackURL": "query.redirect",
        "profile": {
          "username": "payload.username",
          "role": "payload.role",
          "nickname": "payload.nickname",
          "lang": "payload.lang",
          "group": "payload.group",
          "referrer": "payload.referrer||payload.referer",
          "labels": "payload.labels"
        },
        "register": {
          "identifier": "payload.identifier||payload.id",
          "template": "payload.template||'default'",
          "subject": "payload.subject",
          "timeout": "payload.timeout",
          "lifetime": "payload.lifetime",
          "members": "payload.members",
          "invites": "payload.invites",
          "metrics": "payload.metrics",
          "weights": "payload.weights",
          "addons": "payload.addons",
          "threshold": "payload.threshold",
          "locale": "payload.locale",
          "timezone": "payload.timezone",
          "url": "payload.url",
          "api": "payload.api",
          "tags": "payload.tags",
          "openAt": "payload.openAt||payload.scheduledAt",
          "closeAt": "payload.closeAt||payload.deadline",
          "rules": "payload.rules",
          "expires": "payload.expires"
        },
        "submit": {
          "uri": "room.api",
          "method": "POST",
          "body": {
            "identifier": "room.identifier",
            "link": "`https://${room.host}/api/report/${room.identifier}`",
            "status": "room.status",
            "duration": "room.duration",
            "startedAt": "room.startedAt",
            "stoppedAt": "room.stoppedAt",
            "score": "room.score",
            "student": "room.student.username",
            "proctor": "room.proctor.username",
            "comment": "room.comment",
            "signedAt": "room.signedAt",
            "conclusion": "room.conclusion",
            "averages": "room.averages",
            "verified": "room.student.verified"
          },
          "headers": {
            "x-api-key": "secret"
          }
        }
      }
    },
    "sdk": {
      "iframe": {
        "sandbox": "allow-scripts allow-forms allow-modals allow-same-origin allow-popups allow-downloads"
      }
    }
  },
  "comment": ""
}

6. Чек-лист для проверки интеграции