# API Оркестратор

С целью упрощения установки и сокращения выделение мощностей на стороне клиента был разработан сервис, объединяющий все адаптеры - API Оркестратор. Данный сервис представляет собой группу адаптеров для взаимодействия напрямую с API банков.

Описаны инструкции для ОС:

- Инсталляция сервиса в ОС Linux;
- Инсталляция сервиса в ОС Windows;

## Введение настроек в Мультибанке (Транзит 2.0)

После того как была успешно выполнена инсталляция, необходимо ввести ряд настроек в Мультибанке (Транзит 2.0). Необходимо выполнить следующие шаги:

1. В Мультибанке (Транзит 2.0) авторизоваться под пользователем с правами Администратора и перейти в панель настроек администратора в раздел Адаптеры, здесь на начальном этапе будет отображаться только один подраздел – Терминал.

   Настройки Терминала

   В подразделе Терминал в поле `Шаблоны для предзаполнения настроек (заполняются только пустые поля)` следует выбрать готовый шаблон – По умолчанию (localhost), после чего автоматически будет заполнен блок Настройки подключения к маршрутизатору.

   Выбор шаблона при настройке Терминала

   Внимание: если адрес маршрутизатора не соответствует значению localhost, то необходимо ввести нужный адрес. В качестве адреса указывается DNS-имя сервера либо IP адрес (при этом обязательно нужно указать протокол `https://<DNS-имя или IP-адрес>`). Допустимо использование исключительно протокола https, протокол http не поддерживается.

   После того как все настройки были перепроверены и введены, необходимо нажать на кнопку `Отправить`, после чего в меню появится подразделы маршрутизатор, и подразделы Адаптеров банков. В скобках отображаются версии маршрутизатора и адаптеров, а индикаторы серого цвета напротив появившихся подразделов означают, что Маршрутизатор и адаптеры еще не были сконфигурированы. Дальнейшая настройка осуществляется на шагах 2 и 3.

   Подразделы Маршрутизатор и Адаптеры банков

2. Необходимо перейти в подраздел маршрутизатор. Здесь также следует выбрать готовый шаблон в поле `Шаблоны для предзаполнения настроек (заполняются только пустые поля)` - поля с настройками будут заполнены автоматически. Далее важно перепроверить заполненные поля. Например, адрес сервера базы данных (поле `Адрес сервера относительно маршрутизатора`) может отличаться. Следует также перепроверить порты. Дополнительно потребуется заполнить поля `Имя пользователя` и `Пароль` (в блоке Настройки базы данных).

   Внимание: если ранее использовался адаптер Сбербанка, то в настройках базы данных необходимо указать данные уже существующей БД адаптера Сбербанка. Таким образом, все пользователи старого адаптера Сбербанка будут перемещены в новый адаптер. Соответственно повторное подписание оферт в данном случае не потребуется.

   Примечание: если установка является первичной (ранее старая версия адаптера для Сбербанка/Райффайзенбанка не устанавливалась и не использовалась), то понадобится выполнить установку сервера БД PostgreSQL.

   После того как все поля были заполнены и перепроверены, необходимо нажать на кнопку `Отправить`. Индикатор рядом с подразделом Маршрутизатор должен стать зеленым, что свидетельствует о том, что маршрутизатор успешно сконфигурирован.

   Маршрутизатор успешно сконфигурирован

3. На этом этапе осуществляется настройка адаптеров необходимых банков. Необходимо перейти в подраздел Адаптера банка. Для ускорения введения настроек в поле `Шаблоны для предзаполнения настроек (заполняются только пустые поля)` выберите нужный контур (тестовый или промышленный).

   Настройка адаптеров

   После выбора шаблона автоматически будет заполнена большая часть полей. Необходимо будет дозаполнить поля `Идентификатор клиента` и `Секретный код клиента`.

   Для Адаптера Сбербанка также можно дополнительно указать `Адрес сервиса больших файлов для ФПСУ`, при этом поле не является обязательным к заполнению.

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

   После того как все поля были заполнены должным образом, необходимо нажать на кнопку `Отправить`. Если все настройки введены корректно, Адаптер будет успешно сконфигурирован, индикатор напротив Адаптера должен стать зеленым.

   Успешная конфигурация адаптеров

Ссылка для редиректа

- Для Сбербанка - в СББОЛ в услуге SberBusinessAPI в параметре «redirect_uri» необходимо указать адрес терминала (`{адрес хоста}/adapters/sberbank`);
- Для Райффайзенбанка - URI редиректа (`{адрес хоста}/adapters/raiffeisenbankapi`), на который сервис Райффайзенбанка будет отправлять ответы по результатам аутентификации, предварительно требуется согласовать c Райффайзенбанком.

## Настройки адаптеров

Раздел Адаптеры содержит две вкладки:

- Настройка адаптера — параметры подключения адаптера к маршрутизатору и прочие транспортные настройки. Здесь же применяются шаблоны предзаполнения и расширенные настройки;
- Настройки авторизации — учетные данные организации, коды авторизации и пользователи банка, периоды запроса статусов документов.

### Настройка адаптера

На вкладке «Настройка адаптера» параметры выводятся единым списком. Редко используемые и автоматически настраиваемые параметры вынесены в «Расширенные настройки». Переключатель находится в заголовке адаптера - при его включении дополнительные группы параметров выводятся отдельными раскрывающимися блоками. По умолчанию переключатель выключен.

В списке адаптеров слева отображаются название, версия и индикатор состояния адаптера. На вкладке выбранного адаптера доступны действия: «Сохранить», «Скачать лог», «Перезагрузить», «Отключить адаптер».

Настройки, доступные в каждом адаптере:

- `Шаблоны для предзаполнения настроек` — при выборе значения в этом поле, автоматически заполняются пустые поля, уже введенные значения не перезаписываются.
- `Таймаут подключения к API (секунд)` — укажите время ожидания выполнения запроса по API. Запрос вернется с ошибкой, если не выполнится за указанное время. По умолчанию таймаут 100 секунд, рекомендуем увеличить для отправки больших документов.
- `Выключить проверку серверного сертификата со стороны банка` — включите, чтобы отключить проверку сертификата банка. Однако это менее безопасно.
- `Количество одновременных подключений для отправки документов` — укажите количество подключений к сервисам банков для отправки документов. Значение по умолчанию — один.
- `Количество одновременных подключений для запросов статусов` — укажите количество подключений к сервисам банков для запроса статусов. Значение по умолчанию — один.

  Настройки адаптера

#### Расширенные настройки:

Блок Настройки подключения, где предусмотрены следующие поля:

- `Порт для конфигурации` - укажите порт для конфигурации;
- `Порт для отправки сообщений` - укажите порт для отправки сообщений.

Блок Настройки прокси, где предусмотрены следующие поля:

- `Использовать прокси` — включите, если используете прокси;
- `Тип учетных данных` — выберите тип учетных данных для настроек прокси:
  - `Использовать системные учетные данные приложения` — использовать данные, сохраненные в системном хранилище;
  - `Использовать сетевые учетные данные текущего контекста` — использовать данные текущего пользователя, вошедшего в систему;
  - `Расширенный` — включите для указания данных прокси-сервера вручную. После выбора становятся доступны настройки: `Хост`, `Порт`, `Домен`, `Имя пользователя`, `Пароль`.

Блок Прочее, где предусмотрено следующее поле:

- `Директория для логирования относительно папки установки` — укажите относительный путь до папки, куда будут сохраняться логи системы. Можно указать еще не существующую папку — она создастся при сохранении настроек.

  Расширенные настройки

### Вкладка «Настройки авторизации»

На вкладке «Настройки авторизации» расположены следующие разделы:

- `Учетные данные организации` — таблица учётных данных с колонками «Идентификатор клиента» и «Описание». Доступны добавление, изменение и удаление записей, фильтрация по колонкам и сортировка;
- `Таблица кодов авторизации` — сведения о пользователях банка, привязанных к адаптеру (идентификатор клиента, хэш кода авторизации, ФИО, ИНН, КПП, наименование организации, телефон и другие данные в зависимости от банка). Здесь же выполняется получение кода авторизации и по завершении выводится уведомление об успешной авторизации;
- `Период запроса статусов` — при необходимости укажите свой период запроса статусов для документов. По умолчанию статусы запрашиваются 4 раза в течение первого часа, а затем раз в час. Чтобы добавить период, нажмите `Добавить` и в открывшемся окне укажите:
  - `Тип документа` — выберите документ, для которого настраивается период.
  - `1 запрос`, `2 запрос`, `3 запрос`, `4 запрос` — укажите время для первых четырех запросов. Время отсчитывается от предыдущего запроса.
  - `Период` — укажите время между запросами для всех последующих запросов.
  - `Время жизни` — укажите количество, сколько будут отправляться запросы. | В адаптере Сбербанка также находится настройка `Таймаут обработки сообщений (секунд)`. Мультибанк сбрасывает обработку сообщения в банк, если она обрабатывается дольше указанного времени. После сброса сообщение снова становится в очередь на обработку.

  Настройки авторизации

## Адаптер Райффайзенбанка

### Настройка авторизации для адаптера Райффайзенбанка

После того как успешно были выполнены установка, настройка и запуск адаптера Райффайзенбанка, необходимо настроить авторизацию в банке. Для этого перейдите в раздел Адаптеры на вкладку Настройки авторизации.

1. В разделе Учетные данные организации добавьте одну или несколько организаций с помощью кнопки `Добавить`. В модальном окне заполните поля:

   - `Идентификатор клиента*` - текстовое поле, заполняется вручную, допускается ввод любых символов;
   - `Секретный код клиента*` - текстовое поле, заполняется вручную, допускается ввод любых символов;
   - `Описание*` - текстовое поле, указывается дополнительная информация об идентификаторе клиента.

   Нажмите на кнопку `Сохранить`.

   Создание идентификатора клиента

2. Для получения кода авторизации нажмите кнопку `Авторизоваться` в разделе Таблица кодов авторизации. Будет выполнен автоматический переход на страницу авторизации сервиса Райффайзенбанка.

3. На странице авторизации сервиса Райффайзенбанка необходимо ввести логин и пароль, и нажать на кнопку `Войти`:

   Авторизация на странице сервиса Райффайзенбанка

4. После авторизации осуществляется переадресация на Терминал (согласно настройкам адаптера, поле `Адрес, на который будет произведена переадресация при успешном получении accessToken`). Открывается страничка с информацией об успешной авторизации, где необходимо нажать на кнопку `Войти`:

   Успешная авторизация

5. Проверить появление кода авторизации в Таблице кодов авторизации. Убедитесь, что в таблице появился Хэш:

   Появление Хэша в Таблице кодов авторизации

   Столбец `Остаток жизни дней токена` в таблице токенов показывает, сколько дней будет действителен код авторизации. По истечении срока обратитесь в банк за новым кодом.

6. Необходимо полученный хэш привязать к организации. Для этого нужно перейти в настройки соответствующей организации, и в поле `Идентификатор Райффайзенбанка` выбрать из выпадающего списка полученный на шаге 5 хэш (код авторизации). При наличии нескольких кодов авторизации в выпадающем списке, можно дополнительно ориентироваться по имени пользователя.

   Настройки организации - выбор хэша

   После того как код был выбран, необходимо нажать на кнопку `Сохранить`.

7. Счета, для которых планируется получать выписки, используя адаптер, необходимо привязать к модулю «Райффайзенбанк (API)»:

   Настройки счета Райффайзенбанка

8. После того как все шаги были пройдены, следует выполнить тестовый запрос выписки по одному из счетов, настроенных на шаге 7.

### Управление учетными данными организации

В разделе Адаптеры на вкладке Адаптер Райффайзенбанка в таблице `Учетные данные организации` есть возможность добавлять идентификатор клиента. Доступно создание более одного идентификатора клиента.

Учетные данные организации

Для создания следует:

1. Нажать на кнопку `Добавить`
2. В модальном окне заполнить поля (описано выше в шаге 1);
3. Нажать на кнопку `Сохранить`.

Созданная запись с идентификаторром клиента отобразиться в таблице. Для сохранения добавленной записи следует нажать на кнопку `Отправить`.

При необходимости можно редактировать или удалить созданные записи с помощью кнопок в колонке `Действия`.

Для редактирования следует нажать на кнопку , после чего откроется окно редактирования, идентичная окне создания идентификатора клиента. В окне заблокировано только поле `Идентификатора клиента`. Для сохранения изменений следует нажать на кнопку `Сохранить`.

Редактирование идентификатора клиента

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

Удаление идентификатора клиента

В разделе Таблица кодов авторизации созданные идентификаторы отображаются после нажатия на кнопку `Обновить`.

Таблица кодов авторизации

## Адаптер Сбербанка

### Организационная подготовка. Подключение

Для подключения Сбербанка к сервису Мультибанка (Транзит 2.0) мультибанк, необходимо обратиться к клиентскому менеджеру Сбербанка.

В процессе взаимодействия со Сбербанком необходимо будет заполнить Заявление от банка для подключения к сервису/каналу Sber API. Если подключения требует Холдинг (несколько ЮЛ), то сервис API подключается только для головной компании. При этом, необходимо иметь в виду, что в случае наличия планов по подключению к сервису Мультибанка (Транзит 2.0) Мультибанк (и к каналу Sber API) дочерних организаций необходимо выбирать пункт «Прямая интеграция с Банком (холдинг)».

Такой тип интеграции запрашивается по электронной почте в Сбербанк с электронной почты уполномоченного администратора системы Заказчика, указанного изначально в ЛК Головной компании при подключении канала API. Если к каналу Sber API будет подключена одна организация, то выбрать следует пункт «Прямая интеграция с Банком (host2host)».

В ответ на заявление от Сбербанка будет направлена Анкета, содержащие все параметры подключения к сервису SberBusiness API (пример анкеты).

Для настройки Мультибанка (Транзит 2.0) Сбербанка потребуются следующие данные:

- Client_ID (Идентификатор клиента) получаете в Сбербанке,
- Secret_key (Секретный код клиента) получаете в Сбербанке,
- Scope (v1) (Параметр, определяющий права доступа для access_token) получаете в Сбербанке,
- Redirect URI (Адрес, на который будет произведена переадресация при успешном получении accessToken) пользователь отправляет Сбербанку. Значение Redirect URI берется из поля «Адрес, по которому будет произведена переадресация при успешном получении accessToken» после выбора шаблона в поле «Шаблоны для предзаполнения настроек (заменяются только пустые поля)».
- TLS Certificate (Файл сертификата для TLS подключения, Пароль к TLS-сертификату) получется пользователем в Сбербанке.

Эти данные потребуются для подписания оферты. Получить эти данные Вы можете из Анкеты, либо обратившись в техническую поддержку Сбербанка supportdbo2@sberbank.ru Все указанные параметры являются едиными для всех компаний Холдинга. После подключения Sber API в ЛК СББОЛ головной компании на почту ответственному администратору приходят указанные параметры. Отдельной кнопкой выпускается TLS Certificate в ЛК СББОЛ Головной компании.

Ниже подробно будет описан процесс подписания оферты.

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

Внимание: Пользователь СББОЛ подписывает оферту в Мультибанке (Транзит 2.0) для головной организации с точки зрения Sber API (организация, которая имеет client_id Sber API), должен иметь признак ЕИО (единоличный исполнительный орган) и/или доступ к вызову /v1/crypto/eio (метод `GET_CRYPTO_INFO_EIO`, `CRYPTO_CERT_REQUEST_EIO`). В случае отсутствия доступа к этому методу его необходимо заказать – уточнить наличие доступа и заказать его можно, обратившись в техническую поддержку Сбербанка по услуге Sber API supportdbo2@sberbank.ru При подписании оферты дочерних организаций необходимо использовать сертификат пользователя дочерней организации, при этом признак ЕИО (единоличный исполнительный орган) не обязателен.

Для выполнения подписания оферты рекомендуем воспользоваться браузером Google Chrome или Mozilla Firefox. Необходимо выполнить следующие шаги:

1. Для подписания оферты на рабочем месте подписанта необходимо войти в СББОЛ соответствующим пользователем/токеном Сбербанка – см. замечание выше.

2. В дополнительной вкладке браузера в web-интерфейсе Мультибанка (Транзит 2.0) необходимо зайти пользователем с правами Администратора.

3. В интерфейсе Мультибанка (Транзит 2.0) перейти в Настройки в раздел Адаптеры, выбрать адаптер Сбербанка и перейти на вкладку Настройки авторизации. В разделе Таблица кодов авторизации нажать на кнопку `Подписать оферту`:

   Подписание оферты

4. Выбрать способ подписания оферты (Токен или СМС). Для способа СМС дополнительно выбирается адрес для подписи по СМС.

   Выбор способа подписания оферты

   После нажатия на кнопку `Подписать` осуществляется переадресация на Терминал (согласно настройкам адаптера, поле `Адрес, на который будет произведена переадресация при успешном получении accessToken`). Открывается страничка с информацией об успешной авторизации, где необходимо нажать на кнопку `Войти`:

   Успешная авторизация

5. Проверить появление кода авторизации в Таблице кодов авторизации. Убедитесь, что в таблице появился новый код авторизации:

   Появление Хэша в Таблице кодов авторизации

6. В интерфейсе Мультибанка (Транзит 2.0) перейти в Настройки в раздел Организации. Выбрать Организацию, для которой выполнялось подписание оферты, и в карточке данной Организации в поле `Идентификатор Сбербанка` выбрать соответствующий код авторизации из п.5. При наличии нескольких кодов авторизации в выпадающем списке, можно дополнительно ориентироваться по имени организации или по имени пользователя.

   Указание кода авторизации для организации

   Далее необходимо сохранить изменения по кнопке `Сохранить`.

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

Если на шаге 4 возникнет какая-либо ошибка при попытке подписать оферту, пользователю будет выведено соответствующее сообщение. Например, как на рисунке ниже:

Ошибка при подписании оферты

На рисунке выше приведен лишь один из примеров возможных ошибок.

В случае возникновения ошибки, как на рисунке выше, можно дополнительно изучить логи адаптера (подробнее см. раздел Логи и перезагрузка).

### Получение/обновление списка сертификатов и договоров для Сбербанка

При нажатии на строку таблицы кодов авторизации или на кнопку появляются таблицы с данными по выбранной организации:

- Список сертификатов
- Список договоров
- Список кредитных договоров

Просмотр договоров и сертификатов

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

Запрос договоров и сертификатов

#### Получение списка сертификатов

Для ручного запроса списка сертификатов необходимо получить их по кнопке `Получить список сертификатов`

Сам список сертификатов при подписании оферты будет автоматически загружен. Ввиду этого искомая кнопка применяется только при необходимости обновить список сертификатов (при каких либо изменениях).

Получение/обновление списка сертификатов

#### Получение списка договоров

Для работы с зарплатными ведомостями необходимо получить список договоров по кнопке `Получить список договоров`.

Появится таблица со списком договоров:

Появление/обновление списка договоров

#### Получение списка кредитных договоров

Для возможности отправки ПП за счет кредитных средств необходимо получить список кредитных договоров по кнопке `Получить список кредитных договоров`.

Появление/обновление списка кредитных договоров

Внимание: если список сертификатов/договоров/кредитных договоров претерпел какие-либо изменения (после действий с организацией/пользователем, повторного подписания оферты и т. д.), то в Мультибанке (Транзит 2.0) не забудьте обновить его через соответствующую кнопку в настройках.

### Идентификатор клиента в адаптере Сбербанка

В разделе Адаптеры на вкладке Настройки авторизации в таблице `Учетные данные организации` есть возможность создавать идентификатор клиента. Доступно создание более одного идентификатора клиента.

Учетные данные организации

Для создания следует:

1. Нажать на кнопку `Добавить`
2. В модальном окне заполнить поля (значком `*` помечены обязательные для заполнения поля):
   - `Идентификатор клиента*` - код, присвоенный клиенту Сбербанком. Отображается в СББОЛ;
   - `Секретный код клиента*` - код из поля Client_secret в СББОЛ;
   - `Файл сертификата для TLS подключения` - нажмите `Выбрать файл`, чтобы загрузить TLS-сертификат для данной организации;
   - `Пароль к TLS-сертификату` - укажите пароль к загруженному сертификату. Если сертификат выпущен без пароля, оставьте поле пустым;
   - `Описание*` - укажите любое описание. Обязательное поле;
   - `Ручное заполнение ClientScope` - чекбокс, определяющий как заполняется ClientScope:
     - Если чекбокс выбран, становится доступно поле `Параметр, определяющий права доступа для access_token` для указания атрибутов и операций, согласно требованиям Scope (данные также доступны в СББОЛ).
     - Если чекбокс не выбран, становится доступен выпадающий список `Операции` для выбора операций, атрибуты в таком случае не указываются. Если после выбора операций и сохранения настроек выбрать чекбокс ручного заполнения, то поле `Параметр, определяющий права...` заполнится автоматически атрибутами и выбранными операциями.
   - `Включить автообновление секретного кода клиента` - чекбокс включает автоматическое обновление ключа каждые 30 дней. Если выключен, то срок действия ключа истечет через 40 дней, связь со Сбербанком будет недоступна. В таком случае будет необходимо оформить новый код.
3. Нажать на кнопку `Сохранить`.

Создание идентификатора клиента

Созданная запись с идентификатором клиента отобразиться в таблице. Для сохранения добавленной записи следует нажать на кнопку `Отправить`.

При необходимости можно редактировать или удалить созданные записи с помощью кнопок в колонке `Действия`.

Для редактирования следует нажать на кнопку , после чего откроется окно редактирования, идентичная окне создания идентификатора клиента. В окне заблокировано только поле `Идентификатора клиента`. Для сохранения изменений следует нажать на кнопку `Сохранить`.

Редактирование идентификатора клиента

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

Удаление идентификатора клиента

В разделе Таблица кодов авторизации созданные идентификаторы отображаются после нажатия на кнопку `Обновить`.

Таблица кодов авторизации

### Сбербанк - получение нового кода авторизации (взамен старого)

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

1. В настройках организации в поле `Идентификатор организации` необходимо вместо установленного кода Сбербанка выбрать из списка значение Не выбрано, далее нажать на кнопку `Сохранить`.

   Удаление идентификатора Сбербанка в настройках организации

2. В разделе Адаптеры на вкладке Настройки авторизации в таблице кодов авторизации необходимо удалить код для искомой организации:

   Удаление кода авторизации в настройках адаптера

   Внимание: после удаления кода из табличной части необходимо обязательно сохранить настройки адаптера по кнопке `Сохранить`.

3. После выполнения п.2 в дополнительной вкладке браузера требуется войти в СББОЛ под токеном/логином Гендиректора организации, для которой необходимо получить новый код авторизации.

4. В настройках адаптера Сбербанка на вкладке Настройки авторизации в блоке Таблица кодов авторизации необходимо нажать на кнопку `Подписать оферту`.

   Подписание оферты

   Выбрать способ подписания оферты (Токен или СМС). Для способа СМС дополнительно выбирается адрес для подписи по СМС.

   Выбор способа подписания оферты

   После нажатия на кнопку `Подписать` осуществляется переадресация на Терминал. Открывается страница с информацией об успешной авторизации, где необходимо нажать на кнопку `Войти`:

   Успешная авторизация

   Примечание: если при подписании оферты возникла ошибка, необходимо прислать скрин с текстом ошибки, логи Мультибанка (Транзит 2.0) и Сберадаптера на адрес технической поддержки transit-help@nsd.ru.

5. Проверить появление кода авторизации в таблице в настройках авторизации адаптера. Для этого необходимо перейти в Настройки:

   Переход в Настройки

   После чего перейти в раздел Адаптеры, выбрать адаптер Сбербанка в списке, перейти на вкладку Настройки авторизации и убедиться, что в Таблице кодов авторизации появился новый код авторизации:

   Появление Хэша в Таблице кодов авторизации

6. После успешного выполнения предыдущих шагов, необходимо перейти в настройки искомой организации, и в поле `Идентификатор организации` выбрать из списка новый код авторизации для Сбербанка, далее нажать на кнопку `Сохранить`.

   Установка нового идентификатора Сбербанка в настройках организации

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

### Отправка документов с вложением в Сбербанк

Инструкцию по отправке документов с вложением в Сбербанк можно скачать по ссылке ниже:

Скачать инструкцию по отправке документов с вложением в Сбербанк

### Возможные ошибки и их устранение

#### Ошибки Секретного кода клиента (Client secret)

Если не удается подписать Сбероферту и отправить документы в Сбербанк, вероятно дело в истекшем Client secret: по какой-то причине он не обновился автоматически.

Возможные причины ошибок Client secret:

- В настройках авторизации адаптера Сбербанка, в окне организации, не включен чекбокс `Включить автообновление секретного кода клиента`. Чтобы исправить:

  1. Задайте в СББОЛ новый код.
  2. В окне организации укажите новый код в поле `Секретный код клиента`.
  3. Также в окне организации включите чекбокс `Включить автообновление секретного кода клиента`.

- Если Client secret запрашивается пользователем с ролью ЕИО, возможно в настройках авторизации адаптера Сбербанка, в таблице кодов авторизации, отсутствует пользователь ЕИО, или его заблокировали в Сбербанке. Чтобы исправить:

  1. Задайте в СББОЛ новый код.
  2. В окне организации укажите новый код в поле `Секретный код клиента`.
  3. Подпишите оферту пользователем ЕИО. Если подписать оферту не получилось, обратитесь в Сбербанк.

- Если client secret запрашивается через доступ к сервису ЕИО: в настройке `Ручное заполнение ClientScope` адаптера Сбербанка была выбрана опция `Запрос на выпуск сертификата для ЕИО`. Возможно, опция отключена, чтобы исправить:

  1. Включите опцию.
  2. Задайте в СББОЛ новый код.
  3. В окне организации укажите новый код в поле `Секретный код клиента`.
  4. Переподпишите оферту всеми пользователями организации.

#### Ошибки сертификата TLS SSL

Если при отправке документов в Сбербанк возникает ошибка с упоминанием TLS, вероятно дело в сертификате TLS SSL.

Возможные причины ошибок сертификата TLS:

- Не добавлен файл сертификата. Если сертификат не добавлен, то в адаптере Сбербанка под настройкой `Файл сертификата для TLS подключения` будет находиться кнопка Выбрать для выбора сертификата. Чтобы исправить:

  1. Скачайте действующий сертификат в СББОЛ и загрузите с помощью кнопки Выбрать под полем `Файл сертификата для TLS подключения`.
  2. Укажите пароль сертификата в поле `Пароль к TLS-сертификату`, в настройках адаптера Сбербанка. Если сертификат выпущен без пароля, оставьте поле пустым.

- Добавлен неверный файл сертификата. Название загруженного файла невозможно увидеть, поэтому можно сразу попробовать исправить. Чтобы исправить:

  1. Скачайте действующий сертификат в СББОЛ и загрузите с помощью кнопки Выбрать под полем `Файл сертификата для TLS подключения`.
  2. Укажите пароль сертификата в поле `Пароль к TLS-сертификату`, в настройках адаптера Сбербанка. Если сертификат выпущен без пароля, оставьте поле пустым.

- Истек срок действия TLS-сертификата. Срок действия можно посмотреть в локальном хранилище сертификатов. Чтобы исправить:

  1. Выпустите новый сертификат в СББОЛ.
  2. Скачайте новый сертификат в СББОЛ и загрузите с помощью кнопки Выбрать под полем `Файл сертификата для TLS подключения`.
  3. Укажите пароль сертификата в поле `Пароль к TLS-сертификату`, в настройках адаптера Сбербанка. Если сертификат выпущен без пароля, оставьте поле пустым.

- Proxy-сервер блокирует TLS-соединение. При этом, если отключить proxy-сервер, соединение восстанавливается.
  Чтобы исправить, настройте соединение со Сбербанком минуя proxy-сервер.

- Если для проверки сертификатов используется цепочка серверных сертификатов (установленных на сервере с API-Оркестратором), какой-то из них может стать невалидным. Чтобы исправить, в настройках адаптера Сбербанка включите чекбокс `Выключить проверку серверного сертификата со стороны банка`. В таком случае будет проверяться только загружаемый сертификат, однако это менее безопасно.

## Адаптер НРБанка

1. Для работы с банком укажите настройки адаптера в разделе Адаптеры на вкладке Настройка адаптера:

- `Шаблоны для предзаполнения настроек (заполняются только пустые поля)` — выберите шаблон для предзаполнения настроек:
  - `Порт для конфигурации` и `Порт для отправки сообщений` в блоке `Настройки подключения`.
  - `Адрес, на котором расположен сервис API` в блоке `Настройки клиента`.
    После выбора перепроверьте правильность значений, при необходимости измените вручную.
- `Адрес, на который будет произведена переадресация при успешном получении accessToken` — укажите адрес для переадресации после авторизации в адаптере банка.

2. Перейдите на вкладку Настройки авторизации и добавьте одну или несколько организаций с помощью кнопки `Добавить`. В открывшемся окне укажите:

   - `Идентификатор клиента` — обязательное поле. Укажите любое значение.
   - `Секретный код клиента` — обязательное поле. Укажите любое значение.
   - `Описание` — обязательное поле. Укажите любое значение.
     Нажмите `Сохранить`.
     Чтобы отредактировать добавленную организацию, нажмите `Редактировать`, чтобы удалить — `Удалить`.

   Заполните остальные настройки адаптера.

3. Для авторизации нажмите кнопку `Авторизоваться` под таблицей кодов авторизации и в появившемся окне укажите:

- `Учетные данные организации` — выберите одну из организаций, добавленных ранее на вкладке Настройки авторизации.

- `Тип авторизации` — выберите Токен. Авторизация по коду авторизации недоступна.

- `Токен авторизации` — укажите токен авторизации. Токен предоставляется банком.

4. В разделе Организации выберите данный токен в настройке `Идентификатор НРБанка` всех организаций НРБанка.

## Адаптер Т-Банка

Для настройки адаптера получите следующие данные в сервисе Т-Бизнес:

- Токен.
- TLS-сертификат (RSA или ГОСТ) и пароль от него (при наличии).
  Если используете ГОСТ-сертификат, установите его на сервере адаптера Т-банка как личный сертификат пользователя, запускающего службу адаптера Т-банка.
  Если используете RSA-сертификат, скачайте его на машину, на которой будет производиться дальнейшая настройка.

Настройте адаптер:

1. В разделе Адаптеры на вкладке Настройка адаптера выберите адаптер Т-Банка (API) и укажите настройки:

- `Шаблоны для предзаполнения настроек (заполняются только пустые поля)` — выберите шаблон для предзаполнения настроек:
  - `Порт для конфигурации` и `Порт для отправки сообщений` в блоке `Настройки подключения`.
  - `Адрес, на котором расположен сервис API` (для незащищенных запросов) и `Адрес, на котором расположен сервис защищенного API` (для запросов, защищенных TLS-сертификатом) в блоке `Настройки клиента`.
    После выбора перепроверьте правильность значений, при необходимости измените вручную.

2. Перейдите на вкладку Настройки авторизации и добавьте одну или несколько организаций с помощью кнопки `Добавить`. В открывшемся окне укажите:

   - `Описание` — укажите описание.
   - `Тип сертификата` — выберите тип добавляемого сертификата: RSA или ГОСТ.
     Для RSA-сертификата укажите:
   - `Файл сертификата для TLS подключения` — получается в системе Т-бизнес.
   - `Пароль к TLS-сертификату` — пароль выпущенного сертификата. Если сертификат выпущен без пароля, оставьте поле пустым.
     Для ГОСТ-сертификата укажите:
     - `Серийный номер сертификата` — выберите, установленный ранее ГОСТ-сертификат.
       Нажмите `Сохранить`.
       Чтобы отредактировать добавленную организацию, нажмите `Редактировать`, чтобы удалить — `Удалить`.

   Заполните остальные настройки адаптера.

3. Для авторизации нажмите кнопку `Авторизоваться` под таблицей кодов авторизации и в появившемся окне укажите:

- `Учетные данные организации` — выберите одну из организаций, добавленных ранее на вкладке Настройки авторизации.
- `Токен авторизации` — укажите токен авторизации. Получается в системе Т-бизнес.

4. В разделе Организации выберите данный токен в настройке `Идентификатор Т-Банка` всех организаций Т-Банка.

## Адаптер ВТБ МСБ

Адаптер ВТБ МСБ предназначен для взаимодействия с API банка ВТБ для малого и среднего бизнеса. На текущий момент реализованы запросы выписок и платежные поручения.

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

- Client ID (Идентификатор клиента) — идентификатор, который банк передает клиенту для интеграции;
- Пользовательский сертификат в формате PFX — сертификат, который необходимо импортировать в настройки на серверную машину в хранилище пользователя под которым запускается сервис адаптера;
- Корневой сертификат для пользовательского сертификата;
- Корневой сертификат для серверного сертификата — для проверки установки цепочки;
- Логин и пароль — для авторизации в API;

### Настройка адаптера

1. В Мультибанке (Транзит 2.0) авторизоваться под пользователем с правами Администратора и перейти в панель настроек администратора в раздел Адаптеры, выбрать подраздел Адаптер ВТБ МСБ.

2. На вкладке Настройка адаптера в поле `Адрес` указать адрес, который банк передает клиенту для интеграции.

3. Перейти на вкладку Настройки авторизации, в таблице `Учетные данные организации` нажать кнопку `Добавить` и заполнить поля:

   - `ID организации` — вводится ID клиента, полученный от банка, если банк не предоставил идентификатор организации;
   - `ID пользователя` — вводится ID клиента, полученный от банка;
   - `Логин` — логин для авторизации в API ВТБ МСБ;
   - `Пароль` — пароль для авторизации в API ВТБ МСБ;
   - `Файл TLS-сертификата` — загрузить контейнер в формате PFX, полученный от банка;
   - `Пароль к TLS-сертификату` — указать пароль к контейнеру PFX;
   - `Серийный номер сертификата` — указать серийный номер сертификата для установления TLS соединения. Поиск сертификата осуществяется в хранилище пользователя. При заполнении всех трех полей связанных с сертификатом для TLS приоритет отдается поиску по серийному номеру.

   Учетные данные организации ВТБ МСБ

4. Нажать на кнопку `Сохранить`, затем на кнопку `Отправить` для применения настроек.

### Авторизация

1. На вкладке Настройки авторизации в разделе `Таблица кодов авторизации` нажать кнопку `Добавить`.

2. В появивщемся диалоговом окне выбрать запись соответствующую идентификатору пользователя и нажать на кнопку `Авторизоваться`. Будет выполнена авторизация с использованием настроенных учетных данных (логин, пароль, сертификат).

   Авторизация ВТБ МСБ

   После успешной авторизации в таблице кодов авторизации появится запись.

### Настройка организации

1. Перейти в раздел Организации, выбрать организацию, для которой настроен ВТБ МСБ.

2. В поле `Идентификатор ВТБ МСБ` выбрать из выпадающего списка созданный токен авторизации. В списке отображается ID пользователя, ID организации и логин пользователя для удобства ориентирования.

3. Нажать на кнопку `Сохранить`.

### Настройка счета

1. Перейти в настройки счета организации.

2. Заполнить поля:

   - `Идентификатор клиента банка` — указать Client ID, который банк передает пользователю;
   - `Идентификатор банковского отделения` — вводится вручную (значение запрашивается у банка).

3. Нажать на кнопку `Сохранить`.

## Дополнительная информация и документы

В разделах ниже представлена дополнительная информация, которая может быть полезна при работе с сервисом API Оркестратор, и другие инструкции.

### Логи и перезагрузка

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

Сохранение логов

Бывают ситуации когда возникшая проблема может быть решена перезагрузкой маршрутизатора и/или адаптеров. Для этого в подразделах предусмотрена кнопка перезагрузки:

Перезагрузка маршрутизатора/Адаптера

Если с адаптером возникли проблемы, например, в какой-то момент он перестал работать (индикатор стал серый), можно предпринять попытку его перезагрузить по указанной кнопке.

### Мониторинг

В разделе Мониторинг административной панели отображаются последние значения метрик. Здесь же отображены индикаторы доступности к компонентам (Терминал, маршрутизатора и Адаптеры) и к сервисам (доступ к БД, к папкам Файловому шлюзу, скриптам Python):

- красный индикатор свидетельствует о недоступности/ошибке;
- зеленый индикатор свидетельствует о доступности/корректной работе;
- серый индикатор может свидетельствовать о том, что компоненты (маршрутизатор или адаптеры) не были сконфигурированы;

По кнопке `Скачать данные мониторинга` на компьютер пользователя загружается 7z архив. Архив предназначен для передачи в НРД, таким образом анализ содержимого архива пользователями не предусмотрен.

Подробное описание сервиса Мониторинга можно найти в разделе Мониторинг.