...

Предоставляет список ТД в формате JSON, который содержит:

• grRegion - область/регион;
• vspNumber - номер ВСП;
• apID - MAC-адрес устройства;apName
• apRtcGroup - имя устройства;
• grCity - город;
• grRegion - область/регион;
• домен , в котором располагается устройство
• grTB - территориальный банк;
• vspAddressapGroup - графа из справочника с адресом расположение месторасположение ТД;
• vspNumber - номер vspAddress -  адрес ВСП;
• apGroupapName - сформированное по справочнику месторасположение ТДимя устройства;
• apRtcGroup - домен , в котором располагается устройствоgrCity - город;

Пример:

{
    "data": [
        {
            "apGroupgrRegion": "Какой-то банк/Такая-то область/Доп.офис №XXXX-XXXXX"Самарская",
            "apIDvspNumber": "a8-f9-4b-b5-a4-a0****-*****",
            "grTBapID": "Какой-то банк00-00-00-00-00-00",
            "grCityapRtcGroup": "г.Волгоград, Какой-то районtoor.pA",
            "vspNumbergrTB": "XXXX-XXXXXбанк",
            "apRtcGroupapGroup": "Ugбанк/Volgogradskiy_filial/Volgogradskaya_obl/Volgograd/Test_bank/XXXX-XXXX_pr-XXXXXXX_1XСамарская/Доп.офис №****-****",
            "vspAddress": "4XXXX7"******, г.XXXXXСамара, пр.XXXXXXСамарская, 1X*",
            "apName": "test_ap_name_XXXX-XXXX_a8:f9:4b:b5:XX:XX"****-****_Samarskaya_*_00:00:00:00:00:00",
            "grRegiongrCity": "Такая-то областьСамара"
        },
	]
}

Возможные параметры запроса

...

curl -L http://localhost:9190/GetAPList

• grTB - фильтр по полю grTB. При указании этого параметра в ответе от eltex-bob будут содержаться только те объекты, значение grTB которых совпадает с указанным. Если значение параметра пустое, фильтр будет игнорироваться.
  пример запроса:

curl -L http://localhost:9190/GetAPList?grTB='Какой-то банк'

GetAPDetail

Детализация информации по ТД , которая содержит :

• "

...

• firmware-version"

...

• - версия ПО;
• "

...

• full-address" - полный адрес  ТД.
• "vsp" - номер ВСП;
• "city" - город  расположения ТД;
• "serial-number" - серийный номер устройства;
• "

...

• ip"

...

•  - IP-адрес устройства;

...

• grTB - территориальный банк;
• "office" - название офиса , где расположена ТД;
  
  
  

Запрос:

curl -L http://localhost:9190/GetAPDetail/00:-00:-00:-00:-00:-00

Ответ:

{
    "ipfirmware-version": "1921.1680.60.180",
 	"office   "full-address": "Доп.офис №XXX-XXXВолгоград, Металлургов, *",
	"city    "vsp": "г.Березовский"****-*****",
	"firmware-version    "city": "1.16.0.163"Волгоград",
    "serial-number": "WP010001XX",
	"vsp    "ip": "XXX-XXX"
	"full-address": "67XXXX, г.Олекминск, ул.XXXXXX, XXXXX"127.0.0.1",
    "grTB":"банк",
    "office":"Доп.офис №****-****"
}

GetAPAvailable

Доступность ТД, которая содержит:

• "available" - доступность ТД, где 0 - ТД доступна, 1 - ТД недоступна;
• "uptime" - время доступности ТД, в секундах.

Запрос:

curl -L http://localhost:9190/GetAPAvailable/00:-00:-00:-00:-00:-00

Ответ:

{
    "available": 0,
    "uptime": 67370
}

...

Метрики ТД,  которые содержат:

• "wifi_users" - количество подключенных  пользователей

...

• ,
• "mac" - mac-адрес ТД

Запрос:

curl -L http://localhost:9190/GetAPPerformance/00:-00:-00:-00:-00:-00

Ответ:

{
    "wifi_users": "5"
    "mac":"00-00-00-00-00-00"
}

Настройки

...

Для авторизации в сервисе доступно 2 способа:

...

server { 
	listen 80; 
	server_name bob; 
	location /api/ { 
		proxy_pass http://localhost:9190/; 
		proxy_set_header Host $host; 
		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 
		proxy_set_header X-Real-IP $remote_addr; 
		proxy_redirect default; 
	}
}

Настройка профиля юридических лиц

1. В EMS → "Администрирование" → "Права и пользователи" - > "Профили юридических лиц" необходимо добавить профиль, нажав на "+":

Image Added

На вкладке "Описание профиля" заполнить поля "Имя профиля" и "Описание".

На вкладке "Параметры" нужно добавить новый объект и заполнить необходимые поля:

Image Added

2. В EMS → "Администрирование" → "Права и пользователи" - > "Домены" нужно выбрать необходимый домен, нажать кнопку редактирования и добавить созданный профиль:

Image Added

/etc/eltex-bob/application.properties

...

# The Datasource Mysql properties
spring.application.name=bob
h2.console.enabled=true
h2.console.port=9111

spring.datasource.url=r2dbc:mysql://localhost:3306/eltex_ems?useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
spring.datasource.username=javauser
spring.datasource.password=javapassword
spring.datasource.hikari.maximum-pool-size=20

service.profile.id=32
service.profile.fields=office,companytestprofile

spring.mvc.favicon.enabled=false

mac.splitter=:-

auth.enabled=false
auth.username=user
auth.password=password

server.port=9190

• Средство для диагности проблем в сервисном центре

h2.console.enabled=true
h2.console.port=9111

• Подключение к БД:

spring.datasource.url=jdbcr2dbc:mysql://localhost:3306/eltex_ems?useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
spring.datasource.username=javauser
spring.datasource.password=javapassword

...

spring.datasource.hikari.maximum-pool-size=2010

• Данные профиля юридических лиц.

service.profile.id=2
service.profile.fields=testprofile

• Разделители октетов в мак-адресе (в apID и в запросах GetAPDetail, GetAPAvailable, GetAPPerformance, по умолчанию ":-"):

mac.splitter=:-

• Включение авторизации по логин-паролю, false - выключено:

...

auth.username=user
auth.password=password

• Конфигурационный файл для работы со справочником ВСП:

excel.config.file=/etc/eltex-bob/excel_config.yaml

• Порт, который слушает сервис

...

version: "3"
 
services:
  bob:
    image: hub.eltex-co.ru/softwlc/eltex-bob:1.19-<tag>
    network_mode: host
    ports:
      - 9190:9190
      - 9111:9111
    volumes:
      - "/etc/eltex-bob/log4j2.xml:/etc/eltex-bob/log4j2.xml"
      - "/var/log/eltex-bob:/var/log/eltex-bob"
    environment:
      - spring.datasource.url=${BOB_DB_URL}
      - spring.datasource.username=${BOB_DB_USERNAME}
      - spring.datasource.password=${BOB_DB_PASSWORD}
      - service.profile.id=${BOB_CLIENT_PROFILE}
      - service.profile.fields=${BOB_CLIENT_PROFILE_FIELDS}
      - fields=${BOB_CLIENT_PROFILE_FIELDS}

...

# common bob params
BOB_DB_URL=jdbcr2dbc:mysql://<IP-address>100.110.1.228:3306/eltex_ems?useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
BOB_DB_USERNAME=javauser
BOB_DB_PASSWORD=javapassword
BOB_DB_HIKARI_MAXIMUM_POOL_SIZE=20
BOB_CLIENT_PROFILE=32
BOB_CLIENT_PROFILE_FIELDS=office,companytestprofile 

Файлы .env и docker-compose.yml должны находиться в одной папке. Контейнер запускается командой:

...

• BOB_DB_URL - URL для подключекния к БД MySQL;
• BOB_DB_USERNAME - Логин подключения к БД;
• BOB_DB_PASSWORD - Пароль подключения к БД;

Параметры фильтрации

• BOB_CLIENT_PROFILE - id профиля юридических лиц;
• BOB_CLIENT_PROFILE_FIELDS - имя профиля юридических лиц.