Тестирование интеграции

Отдельной песочницы у платформы нет. Интеграцию проверяют на своём аккаунте в личном кабинете с отдельным тестовым сценарием: он работает так же, как рабочий, и не смешивает тестовые сессии с сессиями клиентов.

Подготовка

  1. Создайте тестовый сценарий: раздел «KYC/AML» → «KYC Редактор» → «Создать сценарий» или «Создать копию» у рабочего сценария. Подробно — в руководстве по разделу KYC/AML.
  2. На вкладке «Основные настройки» возьмите «ID Сценария» и «Секретный ключ» — они нужны для запуска виджета и шифрования clientKey.
  3. Для проверок через REST API выпустите отдельный токен в разделе «Доступ» → «API-ключи» (Токены доступа).
  4. Если тестируете виджет, добавьте домен тестового стенда во вкладку «Доступ» → «Разрешённые домены». Виджет работает только на доменах из этого списка и только по HTTPS; изменения вступают в силу в течение 2 минут.

Тестовые данные

  • Не используйте данные реальных клиентов.
  • В clientKey, clientUser и полях анкеты передавайте вымышленные значения, например test_user_001.
  • Для идентификаторов в примерах и логах используйте плейсхолдеры вида 00000000-0000-0000-0000-000000000000.

Проверка вебхука

  1. Поднимите временный HTTPS-эндпоинт, который принимает POST-запросы и записывает их тело.
  2. Укажите его адрес в сценарии: вкладка «Настройки коллбека» → «Бэкэнд колбэк URL».
  3. Нажмите «Отправить тестовый запрос». При успехе появится сообщение «Успешно отправлено».
  4. Пройдите тестовую сессию и проверьте, что уведомления приходят на эндпоинт.

Формат уведомления и все настройки — на странице Вебхуки.

Что учесть при проверке:

  • По умолчанию вебхук отправляется при каждом изменении сессии. Чтобы получать только итог, включите «Уведомлять только если сессия финализирована».
  • Если включено «Зашифровать тело POST-запроса с помощью секретного ключа», тело шифруется секретным ключом сценария — проверьте, что ваш сервер его расшифровывает.
  • Платформа ждёт ответа эндпоинта 30 секунд и не повторяет отправку. Если уведомление не дошло, итог сессии можно получить методом kyc/session/status.

Какие сценарии проверить

СценарийЧто проверить
Успешная проверкаВиджет вызывает successCb, вебхук или kyc/session/status возвращают статус success
ОтказsuccessCb не вызывается; итог (например, failed) получаете из вебхука или kyc/session/status
Пользователь закрыл виджетВызывается closeCb, ваше приложение корректно возвращается в исходное состояние
Сессия истеклаСессия не завершена за время жизни из настроек сценария — статус expired
Повторное открытие завершённой сессииВызывается finalizedCb со статусом сессии

Решение по итогу проверки принимайте по статусу с сервера (вебхук или kyc/session/status), а не по колбэкам виджета. Значения статусов — Статусы сессии.

Ошибки

Если метод API вернул ошибку, найдите её код в справочнике.

Расшифровка кодов — на странице Ошибки.

Перед запуском в работу

  • Замените ID тестового сценария на рабочий.
  • Добавьте рабочие домены в «Разрешённые домены».
  • Укажите в рабочем сценарии адрес боевого обработчика вебхуков.