Работа с PIN-кодами

USB-токены и смарт-карты JaCartaAPI и SDKUSB-токены и смарт-карты JaCarta

Примеры представлены в разделе Операции с PIN-кодами.

bindToken

Для GOST 2, PKI, STORAGE.

Предъявить PIN-код. После успешного выполнения состояние аутентификации переходит в JCWebClient2.Vars.AuthState.binded.

Вводить PIN-код можно одним из способов (см. Способы ввода PIN-кода):

• передав напрямую (аргумент pin);
• используя графический интерфейс приложения JC-WebClient (аргумент useUI);
• используя Антифрод-терминал (аргумент antifraud).

Работает при состоянии аутентификации JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

Примеры в разделе Предъявление PIN-кода.

Аргументы:

tokenID

• Тип: Integer
• Описание: Идентификатор токена. Получается с помощью команды getAllSlots. Значение идентификатора не постоянно, но в рамках сессии не меняется.

pin (Необязательный)

• Тип: String
• Описание: PIN-код.

useUI (По умолчанию: false)

• Тип: Boolean
• Описание: Признак использования графического интерфейса приложения JC-WebClient для ввода PIN. Если равен true, то аргумент pin игнорируется.

antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)

• Тип: PlainObject
• Описание: Параметры для ввода PIN с Антифрод-терминала. Если указан, то аргументы useUI и pin игнорируются.

Параметры:

deviceID (Необязательный)

• Тип: Integer
• Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.

langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)

• Тип: Integer
• Допустимые значения: JCWebClient2.Vars.AftLang
• Описание: Идентификатор языка, используемого для отображения сообщений.

timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)

• Тип: Integer
• Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.

unbindToken

Для GOST2, PKI, STORAGE.

Разорвать защищенный канал, если он установлен, и/или отменить предъявление PIN-кода. После успешного выполнения данной команды состояние аутентификации переходит в JCWebClient2.Vars.AuthState.notBinded.

Необходимо вызывать при завершении сеанса работы с приложением JC-WebClient.

Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

changePIN

Для GOST 2, PKI, STORAGE.

Изменить PIN-код пользователя или администратора на токене.

Вводить PIN-коды можно одним из способов (см. Способы ввода PIN-кода):

• передав напрямую (аргументы oldPin и newPin);
• используя графический интерфейс приложения JC-WebClient (аргумент useUI);
• используя Антифрод-терминал (аргумент antifraud).

Работает при любом состоянии аутентификации для PIN-кода пользователя и JCWebClient2.Vars.AuthState.notBinded для PIN-кода администратора. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

Примеры в разделе Смена PIN-кода пользователя/администратора.

Аргументы:

tokenID

• Тип: Integer
• Описание: Идентификатор токена. Получается с помощью команды getAllSlots. Значение идентификатора не постоянно, но в рамках сессии не меняется.

userType (По умолчанию: JCWebClient2.Vars.UserType.user)

• Тип: String
• Допустимые значения: JCWebClient2.Vars.UserType
• Описание: Тип пользователя.

oldPin (Необязательный)

• Тип: String
• Описание: Старый PIN-код.

newPin (Необязательный)

• Тип: String
• Описание: Новый PIN-код.

useUI (По умолчанию: false)

• Тип: Boolean
• Описание: Признак использования графического интерфейса приложения JC-WebClient. Если равен true, то аргументы oldPin и newPin игнорируются.

antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)

• Тип: PlainObject
• Описание: Параметры для ввода PIN с Антифрод-терминала. Если указан, то аргументы useUI, oldPin и newPin игнорируются.

Параметры:

deviceID (Необязательный)

• Тип: Integer
• Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.

langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)

• Тип: Integer
• Допустимые значения: JCWebClient2.Vars.AftLang
• Описание: Идентификатор языка, используемого для отображения сообщений.

timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)

• Тип: Integer
• Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.

confirmRequired

• Тип: Boolean
• Описание: Признак повторного ввода PIN-кода для подтверждения.

initUserPIN

Для PKI.

Инициализировать PIN-код пользователя на токене.

Вводить PIN-коды можно одним из способов (см. Способы ввода PIN-кода):

• передав напрямую (аргументы adminPin и userPin);
• используя графический интерфейс приложения JC-WebClient (аргумент useUI);
• используя Антифрод-терминал (аргумент antifraud).

Работает при состоянии аутентификации JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

Пример в разделе Инициализация PIN-кода пользователя.

Аргументы:

tokenID

• Тип: Integer
• Описание: Идентификатор токена. Получается с помощью команды getAllSlots. Значение идентификатора не постоянно, но в рамках сессии не меняется.

adminPin (Необязательный)

• Тип: String
• Описание: PIN-код администратора.

userPin (Необязательный)

• Тип: String
• Описание: PIN-код пользователя.

useUI (По умолчанию: false)

• Тип: Boolean
• Описание: Признак использования графического интерфейса приложения JC-WebClient. Если равен true, то аргументы adminPin и userPin игнорируются.

antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)

• Тип: PlainObject
• Описание: Параметры для ввода PIN с Антифрод-терминала. Если указан, то аргументы useUI, adminPin и userPin игнорируются.

Параметры:

deviceID (Необязательный)

• Тип: Integer
• Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.

langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)

• Тип: Integer
• Допустимые значения: JCWebClient2.Vars.AftLang
• Описание: Идентификатор языка, используемого для отображения сообщений.

timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)

• Тип: Integer
• Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.

confirmRequired

• Тип: Boolean
• Описание: Признак повторного ввода PIN-кода для подтверждения.

unblockUserPIN

Для GOST 2, PKI, STORAGE.

Разблокировать PIN-код пользователя на токене.

Вводить PIN-код администратора можно одним из способов (см. Способы ввода PIN-кода):

• передав напрямую (аргументы adminPin);
• используя графический интерфейс приложения JC-WebClient (аргумент useUI);
• используя Антифрод-терминал (аргумент antifraud).

Работает при состоянии аутентификации JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

Пример в разделе Разблокировка PIN-кода пользователя.

Аргументы:

tokenID

• Тип: Integer
• Описание: Идентификатор на токене. Получается с помощью команды getAllSlots. Значение идентификатора не постоянно, но в рамках сессии не меняется.

adminPin (Необязательный)

• Тип: String
• Описание: PIN-код администратора.

useUI (По умолчанию: false)

• Тип: Boolean
• Описание: Признак использования графического интерфейса приложения JC-WebClient. Если равен true, то аргумент adminPin игнорируется.

antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)

• Тип: PlainObject
• Описание: Параметры для ввода PIN с Антифрод-терминала. Если указан, то аргументы useUI и adminPin игнорируются.

Параметры:

deviceID (Необязательный)

• Тип: Integer
• Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.

langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)

• Тип: Integer
• Допустимые значения: JCWebClient2.Vars.AftLang
• Описание: Идентификатор языка, используемого для отображения сообщений.

timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)

• Тип: Integer
• Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.