Справочное руководство включает в себя сведения о возможных допустимых параметрах конфигурации PC и сопутствующих компонентов.

Прикладная система

Для каждой зарегистрированной прикаладной системы возможно сконфигурировать параметры, приведённые ниже.

Адрес отправки информации о событиях

Адрес для отправки информации об устройстве и событиях взаимодействия мобильного приложения, или SDK, с сервером устанавливается двумя способами: путём выполнения запроса Change System Settings к API сервера PCS, или через АРМ РКС.

Описание способа установки параметра через API — в описании API сервера PC.

Перезапуск сервиса PCS не требуется.

Внимание! Обязательным требованием для сбора информации о событиях является установка флага сбора информации о событиях при создании ключа, а для сбора данных об устройстве — ещё и флага сбора информации об устройстве. Подробнее — в описании API сервера.

Адрес отправки коллбэков

Устанавливается через через API PCS, подробнее в описании API сервера PC, или через АРМ РКС, при наличии.

Адреса модулей и БД

Изменение адресов компонентов сервера PC

Описание процесса смены адресов сервера описаны в руководстве по инсталляции.

Параметры подключения к БД

К БД подключаются только модули PCS и PCSS. У каждого своя БД.

Параметры подключения модулей к БД указываются в переменных окружения или в файле application.yml соответствующего модуля, в разделе spring.datasource. Строка подключения к СУБД устанавливается в параметре url. Имя пользователя (схема) и пароль в username и password соответственно.

Параметры кофигурации сервера PC

Конфигурирование PCS

Конфигурирование модуля Server производится через переменные окружения, либо через файл application.yml.

Для модуля необходимо установить следующие параметры для подключения к БД PCS:

spring:
  datasource:
    url: jdbc:postgresql://db-server/pcs-db-name
    username: username
    password: password

Также можно переопределить следующие параметры:

server:
  port: 8080

spring:
  jpa:
    database-platform: org.hibernate.dialect.PostgreSQLDialect

pc:
  server:
    instance-name: PCS

logging:
  level:
    tech.paycon: info

где,

При передаче параметров через переменные окружения, необходимо использовать заглавные буквы, уровни вложенности разделять подчёркиванием (_), дефисы опускать. Пример для передачи параметров подключения к БД через переменные окружения:

SPRING_DATASOURCE_URL=jdbc:postgresql://db-server/db-name=info
SPRING_DATASOURCE_USERNAME=username
SPRING_DATASOURCE_PASSWORD=password

Установка параметров

Прочие параметры конфигурации PC Server устанавливаются путём отправки HTTP POST запросов на сервер PCS — http[s]://PCS/pc-api/server_settings с телом в формате JSON с названиями параметров в качестве ключа, и желаемыми значениями, например:

{
  "DEBUG_INFO":"1"
}

Также задать значения параметров можно в АРМ РКС (при наличии), в разделе настроек модуля PCS.

Параметры конфигурации PC Server

Конфигурирование PCE

Конфигурирование модуля External производится через переменные окружения, либо через файл application.yml.

Для модуля возможно переопределить следующие параметры:

server:
  port: 8081

pc:
  external:
    locale: ru
    themes-path: /opt/pc/pc_themes/
    network-timeout: 5000
    deeplink-scheme: paycontrol
    server:
      url: http://localhost:8080/pc-api/
    kyc:
      url: http://localhost:8083/
logging:
  level:
    tech.paycon: info

где,

При передаче параметров через переменные окружения, необходимо использовать заглавные буквы, уровни вложенности разделять подчёркиванием (_), дефисы опускать. Пример для значений по умолчанию в виде переменных окружения.

LOGGING_LEVEL_TECH_PAYCON=info
PC_EXTERNAL_LOCALE=ru
PC_EXTERNAL_THEMESPATH=/opt/pc/pc_themes/
PC_EXTERNAL_NETWORKTIMEOUT=5000
PC_EXTERNAL_DEEPLINKSCHEME=paycontrol
PC_EXTERNAL_SERVER_URL=http://localhost:8080/pc-api/
PC_EXTERNAL_KYC_URL=http://localhost:8083/

Конфигурирование PCP

Конфигурирование модуля Pusher производится через переменные окружения, либо через файл application.yml.

Для модуля возможно переопределить следующие параметры:

server:
  port: 8082

pc:
  pusher:
    config-path:

logging:
  level:
    tech.paycon: info

где,

Аутентификационные данные и шаблоны для отправки Push-уведомлений в приложения PC уже присутствуют в модуле PCP. Таким образом, для типового использования с приложением PC конфигурирование модуля не требуется. Изменение параметров конфигурации может понадобится для добавления аутентификационных данных и шаблонов уведомлений для отправки Push-уведомлений в приложения заказчика, или, например, для включения режима отладки.

После установки или изменения значений параметров конфигурации, службу необходимо перезапустить.

В параметры конфигурации входят:

• общие параметры модуля;
• аутентификационные данные для приложения (дифференцируются по application/bundle id);
• шаблоны для прикладных систем (дифференцируются по systemid).

Поиск параметров конфигурации осуществляются в следующих директориях последовательно, до нахождения первой из перечисленных:

 - /opt/pc/pc_pusher
 - C:\\pc\\pc_pusher

Структура директории

.
├── apps
│   ├── com.example.corp.dev.json
│   ├── com.example.cort.json
│   ├── com.example.retail.dev.json
│   └── com.example.retail.json
├── systems
│   └── 3550fa38-5d17-4fbf-a660-506227a2ed0e.json
└── pusher.conf.json

Параметры конфигурации PC Pusher

Пример конфигурационного файла PCP

Приведённые значения установлены по-умолчанию

{
  "notification_status_buffer_size": 1000,
  "proxy": {
    "host": null,
    "port": 3128,
    "username": null,
    "password": null
  },
  "push_tasks_pool": {
    "core_size": 5,
    "max_core_size": 50,
    "queue_size": 500
  },
  "performance_log": false,
  "performance_log_period": 1000
}

Аутентификационные данные для приложений

Аутентификационные данные для отправки push-уведомлений в приложения задаются в файлах с именем %app_id%.json в директории apps (где %app_id% — application/bundle ID).

Для iOS достаточно только одного из перечисленных вариантов аутентификации (p8/p12/firebase).

Пример файла с аутентификационными данными:

{
  "android": {
    "type": "service_account",
    "project_id": "...",
    "private_key_id": "...",
    "private_key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
    "client_email": "...",
    "client_id": "...",
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://oauth2.googleapis.com/token",
    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
    "client_x509_cert_url": "...",
    "universe_domain": "googleapis.com"
  },
  "ios": {
    "use_fcm": false,
    "apns_p8": {
      "use_dev_gate": false,
      "apns_key_id": "...",
      "apns_team_id": "...",
      "apns_key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----"
    }
  },
  "huawei": {
    "client_secret": "...",
    "client_id": "..."
  }
}

Получение аутентификационных данных для приложений

APNS (iOS)

1. Зайдите в ваш Apple Developer Account
2. Нажмите "Certificates"
3. Нажмите "Keys"
4. Нажмите the "+" button
5. Дайте имя ключу
6. Нажмите "Enable" в "Apple Push Notifications Service (APNs)"
7. Нажмите "Continue"
8. Нажмите "Register"
9. Нажмите "Download", p8-файл будет загружен

Key ID будет предоставлен в процессе создания ключа.

Team ID, это идентификатор вашей команды в программе Apple Developer.

Firebase (Android, iOS)

PC Pusher использует FCM API для отправки push-уведомлений.

Чтобы получить учетные данные, пожалуйста, выполните следующие действия:

1. Откройте консоль Firebase https://console.firebase.google.com/
2. Откройте страницу вашего проекта
3. Откройте Project settings для приложения или создайте новое приложение
4. Перейдите на вкладку Cloud Messaging
5. Убедитесь, что Firebase Cloud Messaging API (V1) включен для вашего приложения
6. Нажмите на ссылку "Manage Service Accounts", откроется Google Cloud Console
7. Нажмите на запись своей учетной записи службы (должно быть что-то вроде firebase-adminsdk-AAAAAA@AAAAAAAA.iam.gserviceaccount.com).
8. Перейдите на вкладку Keys
9. Нажмите ADD KEY и выберите опцию JSON
10. Сохраните JSON-файл, предоставленный консолью, на свой компьютер
11. Откройте этот файл в текстовом редакторе, скопируйте его содержимое в раздел android файла учетных данных вашего приложения

HMS (Huawei)

Пожалуйста, ознакомьтесь с официальной документацией Huawei

Шаблоны push-уведомлений

Шаблоны push-уведомлений в приложения задаются в файлах с именем %systemid%.json, либо default.json в директории systems. Приоритет имеет файл с указанным SystemID. Пример файла с шаблонами:

{
  "android": {
    "templates": {
      "transaction": [
        {
          "message": {
            "token": "%DEVICE_TOKEN%",
            "android" : {
              "data": {
                "type": "PayControl_v2"
              },
              "notification": {
                "tag": "%USER_ID%",
                "title": "PayControl",
                "body": "Новая операция для подтверждения",
                "icon": "paycontrol_push",
                "sound": "default"
              }
            }
          }
        },
        {
          "message": {
            "token": "%DEVICE_TOKEN%",
            "data": {
              "type": "PayControl_v2",
              "userid": "%USER_ID%",
              "transactionid": "%TRANSACTION_ID%"
            }
          }
        }
      ]
    }
  },
  "ios": {
    "templates": {
      "transaction": [
        {
          "aps": {
            "alert": "Новая операция для подтверждения",
            "sound": "default",
            "badge": 1,
            "mutable-content": 1,
            "category": "NEW_OPERATION"
          },
          "type": "PayControl",
          "userid": "%USER_ID%",
          "transactionid": "%TRANSACTION_ID%",
          "pc_notification_type": "alert",
          "pc_notification_priority": 10,
          "pc_notification_timeout": 600,
          "pc_collapse_id": "%USER_ID%"
        }
      ]
    }
  },
  "huawei": {
    "templates": {
      "transaction": [
        {
          "validate_only": false,
          "message": {
            "android": {
              "notification": {
                "tag": "%USER_ID%",
                "title": "PayControl",
                "body": "Новая операция для подтверждения",
                "icon": "paycontrol_push",
                "click_action": {
                  "type": 3
                }
              }
            },
            "token": [
              "%DEVICE_TOKEN%"
            ]
          }
        },
        {
          "validate_only": false,
          "message": {
            "android": {
              "collapse_key": -1,
              "urgency": "HIGH",
              "ttl": "86400",
              "data": "{\"type\": \"PayControl_v2\",\n\"userid\": \"%USER_ID%\",\"transactionid\": \"%TRANSACTION_ID%\"}"
            },
            "token": [
              "%DEVICE_TOKEN%"
            ]
          }
        }
      ]
    }
  }
}

Шаблоны должны быть помещены в массив [os-type]->templates->transaction и *ДОЛЖНЫ * соответствовать спецификациям APNS / FB / HMS.
Каждое значение в массиве интерпретируется как конкретное push-уведомление (например, вы можете отправить несколько уведомлений за одну транзакцию).

В шаблонах можно использовать следующие переменные

Конфигурирование PCCRT

Конфигурирование модуля АРМ РКС производится через переменные окружения, либо через файл application.yml.

Для модуля возможно переопределить следующие параметры:

server:
  port: 8084

pc:
  crt:
    pcs-url: http://localhost:8080/pc-api/

logging:
  level:
    tech.paycon: info

где,

Конфигурирование Server Signer

Конфигурирование модуля Server Signer производится через переменные окружения, либо через файл application.yml.

Для модуля необходимо установить следующие параметры для подключения к БД PCSS:

spring:
  datasource:
    url: jdbc:postgresql://db-server/pcss-db-name
    username: username
    password: password

Для модуля возможно переопределить следующие параметры:

server:
  port: 8083

spring:
  jpa:
    database-platform: org.hibernate.dialect.PostgreSQLDialect

pc:
  signer:
    secret: ********************************
    url: http://localhost:8083/pc-server-signer-api/confirm_async
    pcs-url: http://localhost:8080/pc-api/

logging:
  level:
    tech.paycon: info

где,

Включение и конфигурирование HTTPS

Добавление сертификата

Для включения HTTPS необходимо сформировать P12-файл, содержащий ключ и цепочку сертификации. После этого необходимо указать в настройках сервиса реквизиты к этому файлу.

Пример для файла конфигурации модуля в YAML

server:
  port: 8443
  ssl:
    key-store-type: PKCS12
    key-store: file:keystore.p12
    key-store-password: changeit
    protocol: TLS

Пример для docker-compose

    environment:
      - SERVER_PORT=8443
      - SERVER_SSL_KEY-STORE-TYPE=PKCS12
      - SERVER_SSL_KEY-STORE=file:keystore.p12
      - SERVER_SSL_KEY-STORE-PASSWORD=changeit
      - SERVER_SSL_PROTOCOL=TLS

Включение аутентификации входящих соединений

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

Пример для файла конфигурации модуля в YAML:

server:
  ssl:
    client-auth: need
    trust-store: file:truststore.p12
    trust-store-password: changeit

Пример для docker-compose:

    environment:
      - SERVER_SSL_CLIENT-AUTH=need
      - SERVER_SSL_TRUST-STORE=file:truststore.p12
      - SERVER_SSL_TRUST-STORE-PASSWORD=changeit

Добавление сертификатов корпоративных УЦ

Для корректной валидации подключения к хостам, использующих сертификат, выпущенный корпоративным УЦ, необходимо передать Java путь к jks-контейнеру и пароль, хранящий корневой и промежуточные сертификаты конечного хоста. Пример добавления сертификата в контейнер:

keytool -keystore CustomerStore.jks -storepass changeit -alias LocalRoot -import -file localhost.crt

Пример передачи пути и пароля к контейнеру с сертификатами УЦ для docker-compose:

    environment:
      - JAVA_TOOL_OPTIONS=-Djavax.net.ssl.trustStore=/opt/pc/CustomerStore.jks -Djavax.net.ssl.trustStorePassword=changeit

Пример передачи параметров через переменную окружения:

JAVA_TOOL_OPTIONS='-Djavax.net.ssl.trustStore=/opt/pc/CustomerStore.jks -Djavax.net.ssl.trustStorePassword=changeit'

Параметры ключа

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

Отпечаток устройства

withFingerPrint — указывает, осуществлять ли привязку устройства к Пользователю PC. В случае наличия в запросе на создание пользователя параметра «флаг привязки пользователя к устройству» со значением «true» при проверке кода подтверждения будет использован отпечаток устройства пользователя. Отпечаток устройства вносится в информацию о пользователе путем вызова метода «Сохранение отпечатка устройства».

Флаг не может быть использован одновременно с флагом указывающим, на тип пользователя "Серверная подпись".

Сбор событий

collectEvent — флаг, указывающий необходимость передачи мобильным приложением информации о событиях и сохранения её сервером в базе данных PC.

Информация об устройстве

collectDeviceInfo — флаг, указывающий необходимость сбора информации об устройстве в составе информации о событии. Учитывается только в случае, если установлен флаг collectEvent.

Информация о сим-карте

collectDeviceSIMInfo — флаг, указывающий необходимость сбора информации о телефоне (SIM-карте). При включении – мобильное устройство передаёт информацию, относящуюся к телефону и SIM-карте в составе информации об устройстве. Учитывается только если установлен флаг collectDeviceInfo. На Android-устройстве необходимо дополнительное разрешение приложению на доступ к информации о телефоне.

Информация о местоположении устройства

collectDeviceLocation — флаг, указывающий необходимость сбора информации о местоположении устройства. При включении – мобильное устройство передаёт координаты местоположения устройства в составе информации об устройстве. Учитывается только если установлен флаг collectDeviceInfo. На мобильном устройстве необходимо дополнительное разрешение на доступ к геолокации.

Запрет перерегистрации открытого ключа

denyRenewPublicKey — флаг, запрещающий перерегистрацию открытого ключа на сервере, если открытый ключ уже был зарегистрирован ранее. Использование этого флага предотвращает возможность "дружественного фрода", когда пользователь подписывает акт признания открытого ключа (если подписание акта признания предусмотрено организацией выпускающей ключ), заново добавляет ключ (при этом асимметричная ключевая пара будет сгенерирована новая), и использует его для подписания. Однако, в акте признания будет неактуальный ключ, что даст возможность пользователю попытаться опротестовать транзакцию, на основании того, что ЭП сгенерирована на ключе, открытый ключ которого не признаёт в виду отсутствия акта признания.

С другой стороны, использование этого флага будет препятствовать добавлению ключа на мобильное устройство вновь, в случае его удаления из приложения или удаления приложения. Таким образом, при использовании этого флага, ключевая информация, полученная от организации, выпустившей ключ может быть использована для добавления ключа в приложение лишь один раз.

Параметры сохранения ключевой информации на устройстве

Запрет использования механизмов безопасности ОС

denyStoreWithOSProtection — флаг, запрещающий сохранение ключа с использованием механизмов безопасности операционной системы мобильного устройства (TouchID/FaceID, Google Key Store).

Требования к паролю

passPolicy указывает вариант требований к сложности пароля при сохранении ключевой информации на мобильном устройстве. Доступны следующие варианты:

• «0» — минимум 6 символов, пароль не обязателен;
• «1» — минимум 6 символов, пароль обязателен;
• «2» — минимум 8 символов (обязательно использование A-Z и a-z) пароль обязателен;
• «3» — минимум 8 символов (обязательно использование A-Z, a-z и 0-9) пароль обязателен.

Скоринг и автоподпись

Скоринг

scoring_enabled — разрешение "скоринга" устройства и поведенческого анализа с помощью дополнительного антифрод-модуля Fraud Hunting Platform (бывш. Secure Bank) от F.A.C.C.T. (ранее Group IB). Лицензируется отдельно.

Во время использования приложения и, возможно (в зависимости от подключённой функциональности) интернет-банка ДБО производится оценка устройства и поведенческой модели использования и её соответствие типичным паттернам поведения этого пользователя.

Автоподписание

autosign_enabled — разрешение автоподписи транзакций на основе результата скоринга устройства и поведенческого анализа. Для автоподписи используется дополнительная асимметричная ключевая пара. Использование этого модуля лицензируется/оплачивается отдельно.

В приложении PС реализована функциональность автоматического подписания с помощью ключа автоподписи. При этом, решение на использование ЭП выработанной на ключе автоподписи принимает сервер PC на основании скоринга. Если уровень оценки не ниже заданного, то сервер разрешает использовать для подтверждения ЭП на ключе для автоподписания.

Отложенный ввод в действие ключевой информации

delayed — флаг отложенного ввода в действие ключа. При его установке ключ, используемый для подтверждения транзакций и проверки кодов аутентификации, не заменяется. Сгенерированный новый ключ помечается как отложенный. Его ввод в действие выполняется одним из следующих способов:

• путем вызова метода Ввод отложенного ключа в действие;
• путем вызова одного из методов: Сохранение отпечатка устройства, Регистрация открытого ключа, Регистрация устройства для отправки PUSH-уведомлений с кодом аутентификации, сформированным на отложенном ключе. Выполнять обновление ключевой информации с флагом отложенного ввода можно неограниченное количество раз. При этом сформированная ранее отложенная ключевая информация будет заменена новой отложенной ключевой информацией. При выполнении обновления без данного флага вся отложенная ключевая информация далее считается недействительной и не может быть введена в действие.

Если значение опционального флага не указано, принимается значение равное «false».

Восстановление ключа

remote_update_enabled — разрешает выполнять восстановление ключа с помощью кодового слова или другого механизма дополнительной аутентификации пользователя.

Серверная подпись

Флаг, указывающий на то, что пользователь подлежит регистрации в модуле серверной подписи, а не в мобильном устройстве. При этом компонент серверной подписи (PCSS) должен быть развернут и настроен. Описание вызовов API для взаимодействия с компонентом доступно в описании API PC.

Флаг не может быть использован одновременно с флагом включения проверки отпечатка устройства.

Использование NFC-токенов

nfc_policy — флаг, определяющий политику использования NFC-токенов на мобильном устройстве для хранения ключа ЭП и генерации ЭП с использованием хранящегося на карте ключа ЭП. Доступны следующие варианты:

• «0» – использование NFC-карты, хранащей закрытый ключ, на мобильном устройстве запрещено. Для всех криптографических операций используется ключевая пара генерируемая на самом мобильном устройстве;
• «1» – использование NFC-карты, хранащей закрытый ключ, на мобильном устройстве опционально. В криптографических операциях может быть использована как ключевая пара, генерируемая на мобильном устройстве, так и ключевой контейнер, хранящийся на NFC-карте;
• «2» – использование NFC-карты, хранащей закрытый ключ, на мобильном устройстве обязательно. Для всех криптографических операций используется ключевая пара, хранящаяся в контейнере на NFC-карте;

Если опциональное значение nfc_policy не установлено, принимается значение равное «0».

Разрешение отправки уведомлений через Telegram

telegram_enabled — флаг, разрешающий отправку уведомлений о наличии неподтверждённых транзакций через Telegram

Контроль количества попыток ввода кода активации и пароля

online_credentials — ограничивает количество некорректных попыток ввода кода активации и пароля к ключу пользователя. При превышении, определяемого сервером, количества неверных попыток ввода, пользовательский ключ блокируется.

Кодирование значений флагов в составе ключевой информации

В составе QR-кода, значения передаются в 7-ой строке данных (для версии сервера 3.x) или в параметре "key_flags" (для версии сервера 5 и выше), целым числом. Значения флагов вычисляются с помощью битовой маски.

KEYFLAG_WITH_FINGERPRINT = (1 << 0);
KEYFLAG_COLLECT_EVENTS = (1 << 1);
KEYFLAG_COLLECT_DEVICEINFO = (1 << 2);
KEYFLAG_COLLECT_SIMINFO = (1 << 3);
KEYFLAG_COLLECT_LOCATION = (1 << 4);
KEYFLAG_PASS_POLICY_POS = (1 << 5); // password policy encoded by 2 bits (4 values)
KEYFLAG_PASS_POLICY_POS = (1 << 6); // password policy encoded by 2 bits (4 values)
KEYFLAG_DENY_STORE_WITH_OS_PROTECTION = (1 << 7);
KEYFLAG_DENY_RENEW_PUBKEY = (1 << 8);
KEYFLAG_SCORING_ENABLED = (1 << 9);
KEYFLAG_AUTOSIGN_ENABLED = (1 << 10);
KEYFLAG_REMOTE_UPDATE_ENABLED = (1 << 11);
KEYFLAG_SERVERSIGNER = (1 << 12);
KEYFLAG_NFC_ENABLED_POS = (1 << 13); // NFC policy encoded by 2 bits (3 values is used)
KEYFLAG_NFC_ENABLED_POS = (1 << 14); // NFC policy encoded by 2 bits (3 values is used)
KEYFLAG_TELEGRAM_ENABLED = (1 << 15);
KEYFLAG_ONLINE_CREDENTIALS = (1 << 16);

События

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

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

Информация о мобильном устройстве

Сбор информации об устройстве – это возможность, которую может использовать организация, выпустившая ключ.

Флаги, разрешающие сбор информации, устанавливаются для ключа при его выпуске (эта возможность должна быть реализована в прикладной системе).

Состав информации

Собираемую информацию об устройстве можно разбить на две группы:

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

Для iOS и Android производится попытка собрать всю доступную информацию. Поля для собираемой информации для обеих платформ одинаковы. В зависимости от того, какая платформа какую информацию отдаёт, они либо заполняются, либо остаются пустыми.

В другом разрезе собираемую информацию можно группировать как:

• Информация, общая для платформ;
• Информация, специфичная для платформы (Android/iOS).

Информация не требующая дополнительных разрешений

При включении опции сбора информации собирается (при наличии технической возможности получения такой информации):

• базовая об устройстве:

  производитель, модель, версия ОС, часовой пояс, установленные значения языковых параметров устройства, а также сведения об аппаратных составляющих (марки процессора, дисплея и т.д.);

• состояние памяти устройства:

  установлена, либо нет карта памяти, её объём, объём ОЗУ и встроенной памяти устройства;

• информация о приложении (собственно об экземпляре, отправляющем эту информацию):

  Название, версия и идентификатор мобильного приложения (BundleID);

• информация о Wi-Fi подключении:

  название подключённой сети, IP и MAC адрес;

• информация о физических сенсорах устройства:

  вывод информации о доступных приложению данных физических сенсоров, таких как акселерометр, датчик освещённости и т.д.

Информация, требующая предоставление разрешения

При включении дополнительных двух опций можно включить сбор (при наличии технической возможности получения такой информации):

• геоданных устройства (Android и iOS):

  значение долготы и широты;

• информации о телефоне и SIM-карте (iOS разрешение не запрашивает):

  оператор сотовой связи, количество сим-карт, страна сим-карты

Пример

Android

{
    "device_fingerprint": "0dffffa8ea589f717f2f0f1033adf4053a179c73a682d9f82edc81f98bbaa1bf",
    "request_type": "get_transactions",
    "pc_instance_name": "pcs-node-1",
    "system_id": "f13e4375-e429-496c-ad1e-0fc3c3ecfb53",
    "key_index": 1,
    "session_id": "ab67a3e2-4503-4a46-8bc4-5016d16370d9",
    "created_at": 1703499267298,
    "request_url": "http:\/\/pcs:8080\/pc-api\/ext\/f13e4375-e429-496c-ad1e-0fc3c3ecfb53\/users\/devapi7postpay-c9b044e1-94fb-4539-a3b4-68c7b6d58ea3\/transactions\/get_list",
    "requester_ip_address": "212.46.10.83, 192.168.88.52,192.168.208.12",
    "request_result": 0,
    "pc_version": {
        "pc_version": "6.0.94",
        "product": "PC Server",
        "pc_api_version": 7
    },
    "device_event_id": "de8cba89-856c-45b7-bcb1-73e18661bedf",
    "device_info": {
        "app": {
            "appName": "PayControl",
            "packageName": "org.paycontrol.app",
            "appVersionName": "6.0.375",
            "appVersionCode": 375
        },
        "wifi": {
            "localIp": "192.168.17.10",
            "userAgent": "Mozilla\/5.0 (Linux; Android 12; SM-G970F Build\/SP1A.210812.016; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/120.0.6099.144 Mobile Safari\/537.36__Dalvik\/2.1.0 (Linux; U; Android 12; SM-G970F Build\/SP1A.210812.016)",
            "SSID": "wifi-name"
        },
        "memory": {
            "totalInternalMemorySize": "118053482496",
            "totalRAM": "5542296"
        },
        "location": {
            "latitude": "55.8816616",
            "accuracy": "15.92",
            "longitude": "37.7001385"
        },
        "osName": "Android",
        "device": {
            "product": "beyond0lteser",
            "screenWidth": 1080,
            "simulator": 0,
            "screenHeight": 2119,
            "timeZone": "Europe\/Moscow",
            "locale": "en",
            "manufacturer": "samsung",
            "osVersion": "12",
            "root": 0,
            "name": "SGS10e",
            "model": "SM-G970F",
            "sdkVersion": 31,
            "screenDensity": "3.0"
        },
        "Android": {
            "memory": {
                "totalExternalMemorySize": "118053482496",
                "hasExternalSDCard": 1
            },
            "sim": {
                "networkCountryIso": "ru",
                "phoneType": "GSM",
                "simCount": 2,
                "simCountryIso": "ru",
                "roaming": 0,
                "simOperatorName": "Beeline",
                "mmsUrl": "http:\/\/wap.samsungmobile.com\/uaprof\/SAMSUNGUAPROF.xml",
                "mmsAgent": "SAMSUNG-ANDROID-MMS\/SM-G970F",
                "networkOperatorName": "beeline"
            },
            "sensor": {
                "minDelay": 5000,
                "vendor": "STM",
                "name": "LSM6DSO Acceleration Sensor",
                "maxRange": 78.45320129394531,
                "type": 1,
                "version": 15932,
                "resolution": 0.002394201699644327
            },
            "device": {
                "scaledDensity": 3.3000001907348633,
                "buildBrand": "samsung",
                "buildTime": 1677717204000,
                "buildUser": "dpi",
                "radioVersion": "G970FXXSGHWB3,G970FXXSGHWB3",
                "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 asimddp;processor=7;CPU part=0x003",
                "buildID": "SP1A.210812.016",
                "defaultSms": "com.samsung.android.messaging",
                "deviceID": "a40eff960948fb41",
                "buildHost": "21DKG923",
                "densityDpi": "480",
                "buildVersionCodeName": "REL",
                "defaultBrowser": "com.android.chrome",
                "certificates": [],
                "bootloader": "G970FXXSGHWC1",
                "displayVersion": "SP1A.210812.016.G970FXXSGHWC1",
                "fingerprint": "samsung\/beyond0lteser\/beyond0:12\/SP1A.210812.016\/G970FXXSGHWC1:user\/release-keys",
                "sysAvailableFeatures": "lcZ7yCt+ea7Ot310SW99aq\/GI7U3jwYHP1d4F6Uc1i4=",
                "sysSharedLibraryNames": "9CAXPbjcF9Xo5k4CqNbgnTrYIGS5L4JBrum2JMuO05U=",
                "device": "beyond0",
                "board": "exynos9820",
                "hardware": "exynos9820",
                "releaseBuildVersion": "12"
            }
        }
    },
    "event_id": 53069,
    "updated_at": 1703499267323,
    "connection_info": {
        "dst": {
            "port": "8080",
            "ip": "192.168.208.3",
            "mac": ""
        },
        "src": {
            "port": "54580",
            "ip": "192.168.208.6",
            "mac": "02-42-C0-A8-D0-03"
        }
    },
    "user_id": "devapi7postpay-c9b044e1-94fb-4539-a3b4-68c7b6d58ea3",
    "request_hash": "f0d883cc27680e4996f54d0da797d00b349bcf21353578b394f06d614c1fb34e",
    "device_time": 1703499266947,
    "request_hmac": "4f6a5ba1b11adb9d3ba1e5502e15801513fd34148c0462cbbdb97f3e1c5d7c9d"
}

iOS

{
    "device_fingerprint": "f17ea70cdc97c36b09cc83034ad7479d34b0d708a6e50443fda0faa1b97c32a6",
    "transaction_id": "39a11d38-2ec5-4185-b671-e9e520a98679",
    "request_type": "get_transaction_data",
    "pc_instance_name": "pcs-node-1",
    "system_id": "f13e4375-e429-496c-ad1e-0fc3c3ecfb53",
    "key_index": 1,
    "session_id": "1875568D-9030-451A-B3CB-A14B88BA2A02",
    "created_at": 1703499524030,
    "request_url": "http:\/\/pcs:8080\/pc-api\/ext\/f13e4375-e429-496c-ad1e-0fc3c3ecfb53\/users\/devapi7postpay-d3d1bd3b-234f-4e5c-a573-72b2584488d5\/transactions\/39a11d38-2ec5-4185-b671-e9e520a98679\/get_data",
    "requester_ip_address": "212.46.10.83, 192.168.88.52,192.168.208.12",
    "request_result": 0,
    "pc_version": {
        "pc_version": "6.0.94",
        "product": "PC Server",
        "pc_api_version": 7
    },
    "device_event_id": "C0E20926-F843-4CA4-A805-D9E83C7A44ED",
    "device_info": {
        "app": {
            "appName": "PayControl",
            "packageName": "org.paycontrol.app",
            "appVersionName": "6.0.18",
            "appVersionCode": 18
        },
        "wifi": {
            "localIp": "192.168.17.34",
            "userAgent": "Mozilla\/5.0 (iPhone; CPU iPhone OS 15_7_9 like Mac OS X) AppleWebKit\/605.1.15 (KHTML, like Gecko) Mobile\/15E148",
            "SSID": "wifi-name"
        },
        "memory": {
            "totalInternalMemorySize": "244120",
            "totalRAM": "2000"
        },
        "location": {
            "latitude": "55.88147053944517",
            "accuracy": "36.0",
            "longitude": "37.70028162477736"
        },
        "osName": "iOS",
        "iOS": {
            "device": {
                "systemFontSize": 14,
                "familyNames": "0c6609032db33d5a40e60d9129bfce88538f9a8f1f3a76fa318fb52e30872f1b",
                "smallSystemFontSize": 12,
                "labelFontSize": 17,
                "availableLocaleIdentifiers": "2014f7e175b2bdaaad2bd0c6f79ad658d8edeb9b5c7c18b17789810eae854e8e",
                "systemFont": ".SFUI-Regular",
                "preferredLanguages": "en-RU, ru-RU, en-GB, zh-Hant-TW, zh-Hant-HK",
                "fontNamesForFamilyName": "c0c83c797dd4858358ade23c161cc289e75530afa75bfd7c0772bdc09cdb4fbc",
                "userInterfaceIdiom": "phone",
                "identifierForVendor": "75C57F5D-2261-4FC1-BC68-07790D3E2E39",
                "buttonFontSize": 18
            }
        },
        "device": {
            "screenWidth": 375,
            "product": "iPhone",
            "simulator": 0,
            "screenHeight": 667,
            "timeZone": "Europe\/Moscow",
            "locale": "en_RU",
            "manufacturer": "Apple",
            "osVersion": "15.7.9",
            "root": 0,
            "name": "iPhone7 (Pink)",
            "screenDensity": "2.0",
            "model": "iPhone9,3",
            "sdkVersion": 15
        }
    },
    "event_id": 53084,
    "updated_at": 1703499524058,
    "connection_info": {
        "dst": {
            "port": "8080",
            "ip": "192.168.208.3",
            "mac": ""
        },
        "src": {
            "port": "44756",
            "ip": "192.168.208.6",
            "mac": "02-42-C0-A8-D0-03"
        }
    },
    "user_id": "devapi7postpay-d3d1bd3b-234f-4e5c-a573-72b2584488d5",
    "request_hash": "2d06b8e8e74935e03cd25bec58c8f6e904363cc3f7e7388040060cfcf8ebf775",
    "device_time": 1703499523986,
    "request_hmac": "8eec7e4b1cf032b4b08299ee4a8325535866e910d196bdaa987b4ba1bbb00c6b"
}

Коды ошибок сервисов

Темы оформления мобильного приложения

Структура архива темы

Файл темы оформления должен соответстововать идентификатору прикладной системы + расширение .zip.

Состав файла:

• theme.json ­— Описание темы
• image_light.png ­— Кастомная картинка для светлого режима приложения
• image_dark.png ­— Кастомная картинка для тёмного режима приложения

Структура файла theme.json

{
    "colors": {
        "accentColor": {
            "light": "#006BFF",
            "dark": "#2F98FF"
        },
        "textButton": {
            "light": "#006BFF",
            "dark": "#2F98FF"
        },
        "accentText": {
            "light": "#006BFF",
            "dark": "#2F98FF"
        },
        "declineButton": {
            "light": "#CFD4DE",
            "dark": "#3C4048"
        },
        "barButton": {
            "light": "#A0AABD",
            "dark": "#6D7586"
        },
        "error": {
            "light": "#E53D00",
            "dark": "#F95E25"
        },
        "success": {
            "light": "#006BFF",
            "dark": "#2F98FF"
        }
    },
    "icon": {
        "light": "icon_light.png",
        "dark": "icon_dark.png"
    },
    "image": {
        "light": "logo_light.png",
        "dark": "logo_dark.png"
    },
    "about": "https://safe-tech.ru/about",
    "feedback": "info@safe-tech.ru"
}

Цвета (Colors)

Цвета описываются в формате #RRGGBB для светлой и тёмной темы по-отдельности.

Иконки/логотипы

В теме могут содержаться логотип или иконка. Необходимо указать название картинки для светлой и тёмной темы. Может использоваться всего одна картинка, указав одно и тоже название для light и dark.

В первую очередь приложение ищет большой логотип по ключу image . Если её нет, то далее приложение ищет иконку по ключу icon. Если и её нет — то будет использоваться дефолтная иконка.

Т.е. если будут указаны оба ключа, то приоритет у image.

Если логотип в приложении не отображается, сверьте название картинки в архиве с тем, что указано в ключе.

Логотип

Если необходимо использование логотипа, то необходимо указать ключ image с названием картинок для светлой и тёмной тем.

Область, которую будет занимать логотип, имеет динамическую ширину. Картинка будет размещена по центру и сжата по высоте.

Рекомендуемый размер логотипа — не менее 792x396, соотношение сторон 2:1

Иконка

Если необходимо использование небольшой иконки, то необходимо указать ключ icon с названием картинок для светлой и тёмной тем.

Иконка будет размещена в квадратной области.

Рекомендуемое разрешение 80x80, соотношение сторон 1:1.

"О приложении" и "Обратная связь"

В тему можно добавить дополнительные ключи — about и feedback. Они будут отображены как текстовые ссылки в информации о ключе.

Публикация темы оформления на сервере PCE

• Убедитесь, что название файла темы имеет вид {systemid}.zip, где {systemid} - идентификатор системы, для которой размещается тема;
• Разместите не распаковывая файл темы на сервере PC External в папке (создав её при необходимости):

Linux

  /opt/pc/pc_themes/v52

или по пути, указанному в application.yml, в параметре pc.external.themes-path, в поддиректории /v52

Пример:

pc:
  external:
    themes-path: /opt/pc/pc_themes/

Windows

по пути, указанному в application.yml, в параметре pc.external.themes-path, в поддиректории \v52

Пример:

pc:
  external:
    themes-path: C:\pc\pc_themes\

Docker

по пути, указанному в файле application.yml, в параметре pc.external.themes-path, либо в переменной окружения PC_EXTERNAL_THEMESPATH, в поддиректории /v52

Пример:

pc:
  external:
    themes-path: /opt/pc/pc_themes/

После добавления файла темы на сервер, он должен стать доступным по адресу:

• http{s}://{servername}/pc-client-api/themes/v52/{systemid}