Skip to content

Instantly share code, notes, and snippets.

@DmitryKirillovRegberry
Created October 4, 2022 11:15
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save DmitryKirillovRegberry/baceceafd50e2e028616bdaa518f35b3 to your computer and use it in GitHub Desktop.
Save DmitryKirillovRegberry/baceceafd50e2e028616bdaa518f35b3 to your computer and use it in GitHub Desktop.
Личный кабинет агента банка 2.0: инструкция по развёртыванию

Личный кабинет агента банка 2.0: инструкция по развёртыванию

Настоящая инструкция описывает процесс развертывания экземпляра ПО «Личный кабинет агента банка 2.0».

Минимальные системные требования (облачная среда)

  • 1 vCPU
  • 2 Gb RAM
  • 10 Gb HDD

Требования к ПО (облачная среда)

  • любая современная ОС семейства Linux
  • Docker v.19 или выше
  • Docker Compose v.1.26 или выше
  • PostgreSQL v.12 или выше

Реквизиты доступа к банковским API

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

Тестовые значения приводятся для примера, их можно использовать для тестирования ПО, реальные заявки в банки с их помощью отправляться не будут.

Банк Открытие

  • URL для отправки заявок
  • URL для получения списка заявок
  • токен

Банк Тинькофф

  • URL для отправки заявок
  • URL для получения списка заявок
  • API-ключ
  • API-секрет
  • ID агента

Банк Точка

  • URL для отправки заявок
  • URL для получения списка заявок
  • токен

Реквизиты доступа для Менеджера

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

Имя пользователя

  • не менее 8 символов
  • не должно быть легко подбираемым словарным словом (admin, manager и т.д.)

Пароль

  • не менее 16 символов
  • содержит строчные и заглавные буквы
  • содержит цифры
  • содержит символы пунктуации

Инструкция по развёртыванию

  1. Создать новую базу данных в PostgreSQL, например:
CREATE DATABASE partnerka;
CREATE USER partnerka WITH ENCRYPTED PASSWORD 'wqkMYYfUNk9PP2yfc';
GRANT ALL PRIVILEGES ON DATABASE partnerka TO partnerka;
  1. Перейти в каталог с приложением.

  2. Указать необходимые реквизиты в файле .env (см. описание ниже):

$ cp .env.example .env
$ vim .env
  1. Запустить приложение в Docker:
$ docker-compose build
$ docker-compose up -d
  1. Для отправки тестовых JSON-запросов можно использовать Postman, Insomnia, cURL или их аналоги.

Описание параметров конфигурации

Параметр Описание
JAR_FILE Путь к JAR-файлу (относительный)
DATASOURCE_URL URL БД
DATASOURCE_USERNAME Имя пользователя БД
DATASOURCE_PASSWORD Пароль БД
LOGGING_LEVEL_ORG Уровень журналирования для библиотек
LOGGING_LEVEL_COM Уровень журналирования для приложения
APP_ADMIN_USERNAME Имя пользователя менеджера
APP_ADMIN_PASSWORD Пароль менеджера
APP_BANK_OPEN_URL_CREATE Открытие: URL для отправки заявок
APP_BANK_OPEN_URL_FETCH Открытие: URL для получения списка заявок
APP_BANK_OPEN_API_TOKEN Открытие: токен
APP_BANK_TINKOFF_URL_CREATE Тинькофф: URL для отправки заявок
APP_BANK_TINKOFF_URL_FETCH Тинькофф: URL для получения списка заявок
APP_BANK_TINKOFF_API_KEY Тинькофф: API-ключ
APP_BANK_TINKOFF_API_SECRET Тинькофф: API-секрет
APP_BANK_TINKOFF_API_ID Тинькофф: ID агента
APP_BANK_TOCHKA_URL_CREATE Точка: URL для отправки заявок
APP_BANK_TOCHKA_URL_FETCH Точка: URL для получения списка заявок
APP_BANK_TOCHKA_API_TOKEN Точка: токен

Пример файла конфигурации (.env)

JAR_FILE=target/partnerka-1.1.4-RELEASE.jar
DATASOURCE_URL=jdbc:postgresql://localhost:5432/partnerka
DATASOURCE_USERNAME=partnerka
DATASOURCE_PASSWORD=wqkMYYfUNk9PP2yfc
LOGGING_LEVEL_ORG=ERROR
LOGGING_LEVEL_COM=DEBUG
APP_ADMIN_USERNAME=admin
APP_ADMIN_PASSWORD=NeJigaMYL4WulPaIc
APP_BANK_OPEN_URL_CREATE=https://www.regberry.ru/import/2022-08-14/open-create.php
APP_BANK_OPEN_URL_FETCH=https://www.regberry.ru/import/2022-08-14/open-fetch.php
APP_BANK_OPEN_API_TOKEN=test
APP_BANK_TINKOFF_URL_CREATE=https://www.regberry.ru/import/2022-08-14/tinkoff-create.php
APP_BANK_TINKOFF_URL_FETCH=https://www.regberry.ru/import/2022-08-14/tinkoff-fetch.php
APP_BANK_TINKOFF_API_KEY=test
APP_BANK_TINKOFF_API_SECRET=test
APP_BANK_TINKOFF_API_ID=test
APP_BANK_TOCHKA_URL_CREATE=https://www.regberry.ru/import/2022-08-14/tochka-create.php
APP_BANK_TOCHKA_URL_FETCH=https://www.regberry.ru/import/2022-08-14/tochka-fetch.php
APP_BANK_TOCHKA_API_TOKEN=test

Контактная информация

В случае возникновения вопросов по развёртыванию ПО «Личный кабинет агента банка 2.0» свяжитесь с нами по следующим контактным данным:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment