Вставьте ссылку SDK

Установить

<script src="https://checkify.me/sdk/v1/checkify.min.js"></script>

После загрузки window.Checkify.version сообщает о выпуске SDK (в настоящее время 1.0.4).

Автоматическое монтирование HTML

. SDK автоматически монтирует элементы с этими атрибутами при загрузке страницы:

<div
  data-checkify-pass="YOUR_PASS_ID"
  data-checkify-request="human"
  data-checkify-text="Verify with Checkify"
  data-checkify-return-url="https://yoursite.com/done"
></div>

Устарело: data-checkify-launcher все еще работает, но регистрирует предупреждение консоли. Вместо этого используйте тип запроса Pass +.

Атрибуты интеграции форм

При использовании Checkify.bindForm вы также можете задать эти параметры для элемента формы:

Checkify.configure(options)

Установите глобальные настройки по умолчанию перед установкой виджетов.

Checkify.configure({
  baseUrl: 'https://checkify.me',
  completeUrl: '/checkify/complete'
});

Checkify.bindForm(form, options)

Render — это кнопка проверки, записывает токен на скрытый вход и отключает отправку до тех пор, пока она не будет проверена.

Checkify.bindForm('#my-form', {
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  buttonTarget: '#checkify-wrap',
  submitButton: '#submit',
  hiddenInput: '#checkify_token',
  disableSubmitUntilVerified: true
});

параметры bindForm

Общие параметры, передаваемые в качестве второго аргумента функции Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

Полностраничный или контейнерный шлюз, который блокирует контент до завершения проверки.

Checkify.createHumanGate({
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  container: '#gate-root',
  title: 'Verify to continue'
});

Поток URL-адресов возврата

Когда пользователи завершают проверку в приложении Checkify, они могут вернуться на ваш сайт с checkify_request_id в строке запроса. SDK автоматически вызывает Checkify.checkReturnedVerification() при загрузке.

Checkify.verify(options)

Программный запуск без bindForm. Передайте DOM-элемент как target (не container — container только для createHumanGate). Для форм предпочтителен bindForm. Возвращает promise, который разрешается при завершении или отмене пользователем.

const result = await Checkify.verify({
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  target: document.getElementById('checkify-root'),
  autoOpenModal: true
});
console.log(result.requestId); // send to your server as request_id

События

window.addEventListener('checkify:verified', (e) => {
  console.log('Verified', e.detail);
});

window.addEventListener('checkify:return', (e) => {
  console.log('Returned from app', e.detail);
});

window.addEventListener('checkify:status', (e) => {
  console.log('Status', e.detail);
});

window.addEventListener('checkify:error', (e) => {
  console.error('Checkify error', e.detail);
});

Опрос состояния (необязательно)

В большинстве случаев проверка должна выполняться при отправке формы с помощью POST-запроса /v1/qr/results/verify. Для пользовательских интерфейсов без встроенного модуля можно запрашивать статус проверки, пока пользователь завершает верификацию в приложении.

• Устаревший токен опроса из более старых встроенных элементов:
• Запросите ID + токен статуса из ответа на начало запроса:

Проверка сервера

Методы