REST API

В разделе приведено описание методов Сервиса Управления Пользователями для работы с SIM-картами. Базовый адрес Сервиса Управления Пользователями:

https://<hostname>/<StsAppName>/ums

Сервис Управления Пользователями предназначен для использования Операторами DSS. Аутентификация Операторов DSS на Сервисе Управления Пользователями осуществляется по сертификату (двустороннее TLS-соединение).

Назначение пользователю аутентификации на SIM-карте

POST user/{id}/simauth

Получение сведений о назначенной пользователю SIM-карте

GET user/{id}/simauth

Удаление SIM-карты, назначенной пользователю

DELETE user/{id}/simauth

Смена ключа аутентификации на SIM-карте

POST user/{id}/simauth/changekeymessage

Параметры

• id - идентификатор пользователя.

Ответ сервиса будет содержать:

• TransactionId - идентификатор транзакции смены ключа аутентификации;
• ActivationCode2 - код смены ключа.

Код смены ключа аутентификации представляет собой список из 10 блоков цифр, которые необходимо ввести пользователю на мобильном устройстве.

Результат смены ключа можно узнать по TransactionId, вызвав метод получения результата транзакции.

Внимание!

Получение результата выполенения запроса на апплете возможно либо через CallBack-сервис, либо переодическим опросом метода получения результата транзакции

Отправка запроса на апплет

POST user/{id}/simauth/message/{messageType}

Имя сообщения	Код сообщения	Описание
Activate	0xAA	Запрос на активацию апплета.
GetStatus	0xAB	Запрос на получение статуса апплета.
ChangePin	0xAC	Запрос изменения ПИН-кода.

Ответ сервиса будет содержать:

• TransactionId - идентификатор транзакции смены ключа аутентификации

Результат запроса к апплету можно узнать по TransactionId, вызвав метод получения результата транзакции.

Внимание!

Получение результата выполенения запроса на апплете возможно либо через CallBack-сервис, либо переодическим опросом метода получения результата транзакции.

Получение результата транзакции

POST user/{id}/simauth/message/{transactionId}

Параметры

• id - идентификатор пользователя.

Ответ сервиса будет содержать:

• AppletResult - результат выполнения операции;
• IsCompleted - флаг, показывающее, завершена ли обработка запроса.

Значения поле AppletResult

Имя	Код	Описание
OperationInProgress	0x00	Операция выполняется (результат будет отправлен в исходящем сообщении).
AppletActivated	0x01	Апплет активирован.
AppletInactive	0x02	Апплет не активирован.
AppletBlocked	0x03	Апплет заблокирован (превышено количество попыток ввода кода активации/PIN).
InvalidMessage	0x04	Неправильный формат сообщения.
AppletIsBusy	0x05	Апплет занят.
AppletAlreadyActivated	0x06	Апплет уже активирован.
AppletActivated2	0x07	Апплет активирован (ключ 2).
OperationConfirmed	0x10	Операция одобрена пользователем.
OperationCancelled	0x11	Операция отменена пользователем.
OperationTimeOut	0x12	Операция не выполнена из-за превышения времени ожидания.
DstkError	0x13	Ошибка обработки DSTK.
PinNotChanged	0x14	ПИН-код не изменен.
PinChanged	0x15	ПИН-код изменен.
TextLengthExceeded	0x17	Превышена длина текста.
KeyAlreadyChanged	0x18	Ключ уже был обновлен.
InvalidKey	0x19	Неверный ключ.
KeyChangeSucceed	0x20	Ключ успешно сменен.