Описание работы API Пикселя для веб-приложений
Для инициализации API Пикселя для веб-приложений необходимо встроить в страницу веб-приложения Заказчика следующий фрагмент кода.
<script type="text/javascript">
!function(){var t=document.createElement("script");t.type="text/javascript",t.async=!0,
t.src="<URL загрузки API Пикселя>",
t.onload=function(){IDX.FrAPI.Init("<Код пикселя>")},
document.head.appendChild(t)}();
</script>
Код пикселя и URL загрузки API Пикселя для веб-приложений выдаются Заказчику представителями IDX.
Методы API Пикселя для веб-приложений¶
В API Пикселя для веб-приложений реализованы следующие функции, вызываемые на странице веб-приложения Заказчика.
Получение идентификатора Фингерпринта¶
Данный метод позволяет получить идентификатор Фингерпринта. Данный идентификатор может использоваться Заказчиком для получения скоринга устройства Клиента через API Ядра.
| Параметр | Описание |
|---|---|
| Метод | IDX.FrAPI.GetFingerprintId() |
| Формат ответа | string |
| Структура данных ответа | Идентификатор Фингерпринта |
Установка идентификатора Сессии¶
Данный метод позволяет установить идентификатор Сессии, которая ранее была инициирована Заказчиком.
| Параметр | Описание |
|---|---|
| Метод | IDX.FrAPI.SetSessionId(<идентификатор сессии>) |
| Формат ответа | нет |
Получение идентификатора Сессии¶
Данный метод позволяет получить идентификатор Сессии, если он ранее был установлен с помощью вызова соответствующего метода.
| Параметр | Описание |
|---|---|
| Метод | Метод IDX.FrAPI.GetSessionId() |
| Формат ответа | string |
| Структура данных ответа | Идентификатор Сессии в формате строки, или null, если идентификатор не установлен |
Сброс идентификатора Сессии¶
Данный метод позволяет сбросить (удалить) идентификатор Сессии, который ранее был установлен Заказчиком через API. При вызове данной функции также генерируется новый идентификатор Фингерпринта.
| Параметр | Описание |
|---|---|
| Метод | IDX.FrAPI.ClearSessionId() |
| Формат ответа | нет |
Отправка фингерпринта в Ядро¶
Данный метод позволяет немедленно отправить новый фингерпринт в Ядро системы для анализа.
| Параметр | Описание |
|---|---|
| Метод | IDX.FrAPI.Hit() |
| Формат ответа | нет |
Пример использования метода API Пикселя для веб-приложений:
try {
var sessionId = window.IDX.FrAPI.GetSessionId();
console.log(sessionId);
}
catch (e) { }