Информация о событиях — различия между версиями

Материал из PayControl Wiki
Перейти к: навигация, поиск
(→‎Типы запросов/событий)
(→‎Типы запросов/событий)
 
(не показано 6 промежуточных версий 2 участников)
Строка 1: Строка 1:
 
== PCv5 ==
 
== PCv5 ==
−
Для версий 5.0 - 5.2.
 
 
=== Свойства записи о событии ===
 
=== Свойства записи о событии ===
 
{| class="wikitable"
 
{| class="wikitable"
Строка 35: Строка 34:
 
|operationid || Идентификатор операции
 
|operationid || Идентификатор операции
 
|-
 
|-
 +
|colspan="2"|<small>''c версии 5.3''</small>:
 +
|-
 +
| request_url || Адрес
 +
|-
 +
| pc_version || Компонент PC, его версия и версия API
 +
|-
 +
| system_id || Идентификатор прикладной системы
 +
|-
 +
| connection_info || Данные о сетевом подключении, связанного с событием
 +
|-
 +
| pc_instance_name || Название экземпляра PC
 +
|-
 +
|colspan="2"|<small>''c версии 5.4''</small>:
 +
|-
 +
| device_fingerprint || Отпечаток устройства (если он требуется, определяется с помощью соответствующего флага при выпуске ключа)
 +
|-
 +
| key_index || Порядковый номер ключа для пользователя
 
|}
 
|}
 +
 
=== Типы запросов/событий ===
 
=== Типы запросов/событий ===
 
{| class="wikitable"
 
{| class="wikitable"
Строка 134: Строка 151:
 
|get_event_info || Получение подробной информации для указанного события
 
|get_event_info || Получение подробной информации для указанного события
 
|-
 
|-
−
|create_certificate || Создание PKI сертификата пользователя
+
|create_certificate || Создание PKI сертификата пользователя <small>''Только в 5.2. С 5.3 изменено на <code>create_certificate_request</code>.''</small>
 
|-
 
|-
 
|get_certificate_status || Получение статуса сертификата пользователя
 
|get_certificate_status || Получение статуса сертификата пользователя
Строка 154: Строка 171:
 
| password_changed || Событие изменения пароля
 
| password_changed || Событие изменения пароля
 
|-
 
|-
 +
| create_certificate_request || Создание запроса на сертификат пользователя
 +
|-
 +
| issue_certificate || Запрос на сертификат пользователя подписан. Выпуск сертификата.
 +
|-
 +
| gen_confirm_code || Генерация сервером кода подтверждения на симметричном ключе пользователя
 +
|-
 +
| check_confirm_code || Проверка кода подтверждения выработанного на симметричном ключе пользователя для подтверждаемых без создания транзакции данных
 +
|-
 +
| gen_common_confirm_code || Генерация сервером кода подтверждения на симметричном ключе сервера для подтверждаемых без создания транзакции данных
 +
|-
 +
| check_common_confirm_code || Проверка кода подтверждения выработанного на симметричном ключе сервера для подтверждаемых без создания транзакции данных
 
|}
 
|}
  
Строка 254: Строка 282:
 
}</syntaxhighlight>
 
}</syntaxhighlight>
 
==== Для версии 5.3 ====
 
==== Для версии 5.3 ====
−
<syntaxhighlight lang="json">{
+
Опционально, записи о событиях могут дополняться идентификатором экземпляра, который задаётся через установку параметра <code>pc_instance_name</code> окружения Java, например <code>-Dpc_instance_name=pcs-node-1</code>
−
     "request_type": "get_operation_list",
+
<syntaxhighlight lang="json">
 +
{
 +
    "transaction_id": "fc320b42-d6c0-4528-b2ae-f29389dbe8a6",
 +
     "request_type": "confirm_transaction",
 +
    "pc_instance_name": "pcs-node-1",
 +
    "session_id": "cf52588e-9e9b-4730-83bc-88733b314a7e",
 
     "created_at": 1625599693574,
 
     "created_at": 1625599693574,
−
    "session_id": "af94f0bd-9cf7-48d8-b866-f5d4a6dc3439",
+
     "request_url": "http:\/\/localhost:8080\/pc-api\/ext\/e55d3d79-327e-4c23-b152-967a57258d57\/users\/devapi4postpay-e6c89a0c-7ca5-4d71-a01c-5f1d4b200c16\/transactions\/fc320b42-d6c0-4528-b2ae-f29389dbe8a6\/confirm",
−
     "request_url": "http:\/\/localhost:8080\/pc-api\/ext\/1f639fb8-8613-4461-8f14-61a73aced9c3\/users\/stageapi4postpay-c0b9784f-4d21-410c-901d-1e151dea745b\/operations\/get_list",
 
 
     "requester_ip_address": "192.168.9.105, 192.168.8.52,172.19.0.3",
 
     "requester_ip_address": "192.168.9.105, 192.168.8.52,172.19.0.3",
 
     "request_result": 0,
 
     "request_result": 0,
Строка 266: Строка 298:
 
         "pc_api_version": 4
 
         "pc_api_version": 4
 
     },
 
     },
−
     "device_event_id": "f8c80e6c-806e-4894-9683-f931d58092e6",
+
     "device_event_id": "b06c4b3d-ac42-4445-baf5-58bcb9bb767c",
 
     "device_info": {
 
     "device_info": {
 
         "app": {
 
         "app": {
Строка 366: Строка 398:
 
     "request_hash": "8e5c46a112ab4bcfe4623462a08ab4ec7cf0434ba23c76efaccd3bf42fecea73",
 
     "request_hash": "8e5c46a112ab4bcfe4623462a08ab4ec7cf0434ba23c76efaccd3bf42fecea73",
 
     "device_time": 1625599692934,
 
     "device_time": 1625599692934,
−
     "request_hmac": "e1bf3050e2ca8b676073f4c13928bdac3fc29d759e82aeb905a0cda25d5c7026"
+
     "request_hmac": "e1bf3050e2ca8b676073f4c13928bdac3fc29d759e82aeb905a0cda25d5c7026",
 
}</syntaxhighlight>
 
}</syntaxhighlight>
 
[[Категория:События и информация]]
 
[[Категория:События и информация]]

Текущая версия на 16:57, 15 марта 2023

PCv5

Свойства записи о событии

Наименование свойства события Описание
event_id Идентификатор события в журнале аудита системы
created_at Время создания записи в журнале аудита системы
user_id Идентификатор пользователя
transaction_id Идентификатор транзакции
session_id Идентификатор сессии на мобильном устройстве
device_event_id Идентификатор события на мобильном устройстве
device_time Время события на мобильном устройстве
auth_code Код аутентификации запроса
request_hash Хэш-сумма запроса
request_hmac Код аутентификации тела запроса
request_type Тип запроса/события
device_info Информация об устройстве
requester_ip_address IP адрес источника запроса
request_result Результат выполнения запроса (0 - успех, другое значение ивляется кодом ошибки)
operationid Идентификатор операции
c версии 5.3:
request_url Адрес
pc_version Компонент PC, его версия и версия API
system_id Идентификатор прикладной системы
connection_info Данные о сетевом подключении, связанного с событием
pc_instance_name Название экземпляра PC
c версии 5.4:
device_fingerprint Отпечаток устройства (если он требуется, определяется с помощью соответствующего флага при выпуске ключа)
key_index Порядковый номер ключа для пользователя

Типы запросов/событий

Событие Описание
decline_transaction Отмена транзакции
autoconfirm_transaction Автоподтверждение транзакции
confirm_transaction Подтверждение транзакции
create_transaction Создание транзакции
get_autoconfirm_list Получение списка транзакций для автоподтверждения
get_transactions Получение списка транзакций
get_transaction_info Получение информации о транзакции
get_transaction_data Получение данных транзакции
get_transaction_binary_data Получение бинарных данных транзакции
attempt_scoring_details Детали скоринга попытки автоподтверждения
change_user Изменение пользователя
create_user Создание пользователя
renew_key_challenge Отправлен челлендж для подтверждения удалённого (по инициативе мобильного приложения) обновления ключевой информации
renew_key_response Получен ответ на челлендж для удалённого (по инициативе мобильного приложения) обновления ключевой информации
remote_update_user_key Инициирован процесс удалённого (по инициативе мобильного приложения) обновления ключа пользователя
export_user_key Экспорт инициализационной ключевой информации
update_user_key Запрос на обновление ключа пользвателя
delete_user Удаление пользователя
get_user_info Получение информации о пользователе
remote_update_set_template Установка шаблона для удалённого обновления ключа пользователя
remote_update_get_available_template Получение списка доступных шаблонов для удалённого обновления ключа пользователя
remote_update_get_requisites Получение установленных параметров для удалённого обновления ключевой информации
get_scoring_settings Получение параметров конфигурации скоринга
register_system Регистрация прикладной системы
get_system_info Получение информации о прикладной системе
change_system Изменение параметров прикладной системы
remove_system Удаление прикладной системы
system_report Получение функционального отчёта об использовании системы
billing_close Закрытие расчётного периода для постоплатной системы расчётов
rks_events_data Получение информации о событиях для указанного пользователя через АРМ РКС (или посредством API на эндпоинт РКС в составе API сервера PCS)
rks_transactions_data Получение информации о транзакции через АРМ РКС (или посредством API на эндпоинт РКС в составе API сервера PCS)
rks_check_confirmation Проверка значения ЭП через АРМ РКС (или посредством API на эндпоинт РКС в составе API сервера PCS)
rks_user_details Получение информации о пользователе через АРМ РКС (или посредством API на эндпоинт РКС в составе API сервера PCS)
key_deleted Ключевая информация удалена с мобильного устройства
root_detected Обнаружен root/jailbreak на мобильном устройстве
high_risk_apps_detected Обнаружены потенциально вредоносные приложения
password_incorrect Введён некорректный пароль доступа к ключевой информации на мобильном устройстве
c версии 5.2:
get_signed_pdf Получение подписанного PDF
reassemble_pdf Добавление ране сформированной ЭП в оригинальный PDF файл
create_operation Создание операции
update_operation Изменение операции
get_operation_info Получение информации об операции
get_operation_list Получение списка операций
get_operation_data_list Получение данных операции
operations_process Обработка операций
get_event_info Получение подробной информации для указанного события
create_certificate Создание PKI сертификата пользователя Только в 5.2. С 5.3 изменено на create_certificate_request.
get_certificate_status Получение статуса сертификата пользователя
revoke_certificate Отзыв сертификата пользователя
rks_check_cms Проверка значения ЭП CMS через АРМ РКС (или посредством API на эндпоинт РКС в составе API сервера PCS)
rks_check_pdf Проверка значения ЭП PDF через АРМ РКС (или посредством API на эндпоинт РКС в составе API сервера PCS)
c версии 5.3:
get_events Получение событий с использованием фильтров при выполнении запроса
clean_events Очистка информации из записей о событиях, очищаются поля device_info, event_data, connection_info.
password_correct Событие ввода пароля
password_changed Событие изменения пароля
create_certificate_request Создание запроса на сертификат пользователя
issue_certificate Запрос на сертификат пользователя подписан. Выпуск сертификата.
gen_confirm_code Генерация сервером кода подтверждения на симметричном ключе пользователя
check_confirm_code Проверка кода подтверждения выработанного на симметричном ключе пользователя для подтверждаемых без создания транзакции данных
gen_common_confirm_code Генерация сервером кода подтверждения на симметричном ключе сервера для подтверждаемых без создания транзакции данных
check_common_confirm_code Проверка кода подтверждения выработанного на симметричном ключе сервера для подтверждаемых без создания транзакции данных

Пример

Для версий 5.0 - 5.2

{
    "device_event_id": "e71426df-be90-408a-bef5-111ffe60c831",
    "device_info": {
        "app": {
            "appName": "PayControl",
            "packageName": "org.paycontrol.app",
            "appVersionName": "5.0.135-Release",
            "appVersionCode": 135
        },
        "wifi": {
            "macAddress": "F6:32:A7:61:24:9D",
            "localIp": "192.168.19.173",
            "userAgent": "Mozilla\/5.0 (Linux; Android 10; SM-G970F Build\/QP1A.190711.020; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/84.0.4147.125 Mobile Safari\/537.36__Dalvik\/2.1.0 (Linux; U; Android 10; SM-G970F Build\/QP1A.190711.020)",
            "SSID": "SafeTech-2-5Ghz"
        },
        "memory": {
            "totalExternalMemorySize": "118032510976",
            "totalInternalMemorySize": "118053482496",
            "hasExternalSDCard": 1,
            "totalRAM": "5524932"
        },
        "sim": {
            "networkCountryIso": "ru",
            "phoneType": "GSM",
            "simCount": 2,
            "simCountryIso": "ru",
            "roaming": 0,
            "IMSI": "",
            "simOperatorName": "Beeline",
            "mmsUrl": "http:\/\/wap.samsungmobile.com\/uaprof\/SAMSUNGUAPROF.xml",
            "imei": "",
            "mmsAgent": "SAMSUNG-ANDROID-MMS\/SM-G970F",
            "simSerial": "",
            "networkOperatorName": "Beeline"
        },
        "sensor": {
            "minDelay": 2000,
            "vendor": "STM",
            "name": "LSM6DSO Acceleration Sensor",
            "maxRange": 78.453201293945,
            "type": 1,
            "version": 15932,
            "resolution": 0.0023942016996443
        },
        "location": {
            "latitude": "55,7888752",
            "accuracy": "96,00",
            "longitude": "37,5042244"
        },
        "device": {
            "screenWidth": 1080,
            "radioVersion": "G970FXXU8CTG4,G970FXXU8CTG4",
            "locale": "ru",
            "manufacturer": "samsung",
            "buildHost": "21HHAD24",
            "buildVersionCodeName": "REL",
            "osVersion": "10",
            "defaultBrowser": "com.android.chrome",
            "bootloader": "G970FXXU8CTG4",
            "root": 0,
            "fingerprint": "samsung\/beyond0lteser\/beyond0:10\/QP1A.190711.020\/G970FXXU8CTG4:user\/release-keys",
            "model": "SM-G970F",
            "hardware": "exynos9820",
            "product": "beyond0lteser",
            "simulator": 0,
            "buildBrand": "samsung",
            "buildTime": 1594894183000,
            "buildUser": "dpi",
            "screenHeight": 2119,
            "timeZone": "Europe\/Moscow",
            "cpu": "BogoMIPS=52.00;CPU implementer=0x53;CPU architecture=8;CPU variant=0x1;CPU revision=0;Features=fp asimd evtstrm aes pmull sha1 sha2 crc32 atomics fphp asimdhp cpuid asimdrdm dcpop;processor=7;CPU part=0x003",
            "defaultSms": "com.samsung.android.messaging",
            "deviceID": "a450af03e00db165",
            "certificates": [

            ],
            "serial": "unknown",
            "displayVersion": "QP1A.190711.020.G970FXXU8CTG4",
            "name": "SV-SGS10e",
            "sdkVersion": 29,
            "screenDensity": "xxhdpi",
            "device": "beyond0",
            "board": "exynos9820",
            "releaseBuildVersion": "10"
        }
    },
    "event_id": 8210,
    "request_type": "get_transactions",
    "user_id": "stage51-7dbe69b2-4bdf-4a4f-a004-58e90131dde2",
    "request_hash": "562e21ae186ab3684011f70d23956549bb3af1fcf37d59503b34364749b94814",
    "session_id": "e3ef6099-d700-45e0-9988-e77197107030",
    "request_hmac": "ae5e6da7628bd95a81543013902bd0bdee25bc6aa64eb0f8c7b857d996dda3a9",
    "request_result": 0,
    "requester_ip_address": "31.173.87.93,192.168.117.19"
}

Для версии 5.3

Опционально, записи о событиях могут дополняться идентификатором экземпляра, который задаётся через установку параметра pc_instance_name окружения Java, например -Dpc_instance_name=pcs-node-1 

{
    "transaction_id": "fc320b42-d6c0-4528-b2ae-f29389dbe8a6",
    "request_type": "confirm_transaction",
    "pc_instance_name": "pcs-node-1",
    "session_id": "cf52588e-9e9b-4730-83bc-88733b314a7e",
    "created_at": 1625599693574,
    "request_url": "http:\/\/localhost:8080\/pc-api\/ext\/e55d3d79-327e-4c23-b152-967a57258d57\/users\/devapi4postpay-e6c89a0c-7ca5-4d71-a01c-5f1d4b200c16\/transactions\/fc320b42-d6c0-4528-b2ae-f29389dbe8a6\/confirm",
    "requester_ip_address": "192.168.9.105, 192.168.8.52,172.19.0.3",
    "request_result": 0,
    "pc_version": {
        "pc_version": "5.3.201-pgsql",
        "product": "PC Server",
        "pc_api_version": 4
    },
    "device_event_id": "b06c4b3d-ac42-4445-baf5-58bcb9bb767c",
    "device_info": {
        "app": {
            "appName": "PayControl",
            "packageName": "org.paycontrol.app",
            "appVersionName": "5.2.197-Release",
            "appVersionCode": 197
        },
        "wifi": {
            "macAddress": "",
            "localIp": "192.168.9.105",
            "userAgent": "Mozilla\/5.0 (Linux; Android 11; SM-G970F Build\/RP1A.200720.012; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/91.0.4472.120 Mobile Safari\/537.36__Dalvik\/2.1.0 (Linux; U; Android 11; SM-G970F Build\/RP1A.200720.012)",
            "SSID": ""
        },
        "memory": {
            "totalExternalMemorySize": "118032510976",
            "totalInternalMemorySize": "118053482496",
            "hasExternalSDCard": 1,
            "totalRAM": "5546068"
        },
        "sim": {
            "networkCountryIso": "ru",
            "phoneType": "GSM",
            "simCount": 2,
            "simCountryIso": "ru",
            "roaming": 0,
            "IMSI": "",
            "simOperatorName": "Beeline",
            "mmsUrl": "http:\/\/wap.samsungmobile.com\/uaprof\/SAMSUNGUAPROF.xml",
            "imei": "",
            "mmsAgent": "SAMSUNG-ANDROID-MMS\/SM-G970F",
            "simSerial": "",
            "networkOperatorName": "Beeline"
        },
        "sensor": {
            "minDelay": 2000,
            "vendor": "STM",
            "name": "LSM6DSO Acceleration Sensor",
            "maxRange": 78.45320129394531,
            "type": 1,
            "version": 15932,
            "resolution": 0.002394201699644327
        },
        "location": {
            "latitude": "55.11000001",
            "accuracy": "48.00",
            "longitude": "37.2244004"
        },
        "device": {
            "screenWidth": 1080,
            "radioVersion": "G970FXXSBFUE6,G970FXXSBFUE6",
            "locale": "en",
            "manufacturer": "samsung",
            "buildHost": "21DJ6552",
            "buildVersionCodeName": "REL",
            "osVersion": "11",
            "defaultBrowser": "",
            "bootloader": "G970FXXSBFUE6",
            "root": 0,
            "fingerprint": "samsung\/beyond0lteser\/beyond0:11\/RP1A.200720.012\/G970FXXSBFUE6:user\/release-keys",
            "model": "SM-G970F",
            "hardware": "exynos9820",
            "product": "beyond0lteser",
            "simulator": 0,
            "buildBrand": "samsung",
            "buildTime": 1621935403000,
            "buildUser": "dpi",
            "screenHeight": 2119,
            "timeZone": "Europe\/Moscow",
            "cpu": "BogoMIPS=52.00;CPU implementer=0x53;CPU architecture=8;CPU variant=0x1;CPU revision=0;Features=fp asimd evtstrm aes pmull sha1 sha2 crc32 atomics fphp asimdhp cpuid asimdrdm dcpop;processor=7;CPU part=0x003",
            "defaultSms": "com.samsung.android.messaging",
            "deviceID": "a450af01e11db222",
            "certificates": [],
            "serial": "",
            "displayVersion": "RP1A.200720.012.G970FXXSBFUE6",
            "name": "My-SGS10e",
            "sdkVersion": 30,
            "screenDensity": "xxhdpi",
            "device": "beyond0",
            "board": "exynos9820",
            "releaseBuildVersion": "11"
        }
    },
    "event_id": 72895,
    "system": "1f639fb8-8613-4461-8f14-61a73aced9c3",
    "connection_info": {
        "destination": {
            "port": "8080",
            "ip": "127.0.0.1",
            "mac": ""
        },
        "remote": {
            "port": "60598",
            "ip": "127.0.0.1",
            "mac": ""
        }
    },
    "user_id": "stageapi4postpay-c0b9784f-4d21-410c-901d-1e151dea745b",
    "request_hash": "8e5c46a112ab4bcfe4623462a08ab4ec7cf0434ba23c76efaccd3bf42fecea73",
    "device_time": 1625599692934,
    "request_hmac": "e1bf3050e2ca8b676073f4c13928bdac3fc29d759e82aeb905a0cda25d5c7026",
}
Источник — «https://repo.paycontrol.org/wiki/index.php?title=Информация_о_событиях&oldid=738»