Управление API и приложениями

Доступ к данному разделу открывается после одобрения заявки на подключение к Open Banking ( Подключение к Open Banking ) или к ЦОИД ( Подключение к ЦОИД )

Раздел "Услуги" предназначен для публикации его API и регистрации приложений участника, для подключения к API других участников или подключения к услугам ЦОИД.

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

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

Краткий алгоритм публикации API:

1. Во вкладке "Настройка API" произвести настройки API.

2. Во вкладке "Мои API" запустить тесты, которые необходимо пройти успешно и нажать "Опубликовать API".

3. Во вкладке "Услуги" для опубликованного API изменится статус на "услуга активна".

Раздел "Услуги"

Главная страница раздела "Услуги" содержит вкладки:

1. Услуги - отображает список доступных услуг/сервисов.

2. Мои приложения - содержит список приложений участников.

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

Client Secret приложения должен сохраняться в тайне и не передаваться в публичный доступ, должен храниться на серверной стороне приложения, и вся обработка, связанная с ним, должна производиться на серверной стороне приложения

Регистрация приложения

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

1. Нажать на кнопку <Добавить приложение>.

1. Заполнить форму регистрации приложения, содержащую:

• кнопку <Логотип> – при нажатии на которую открывается окно для выбора файла с изображением логотипа для приложения. Формата изображения должен быть png, размером 100*100 px.

• поле <Наименование> – для ввода наименования приложения.

• поле <Client ID> – уникальный идентификатор приложения, генерируется автоматически, недоступно для редактирования.

• поле <Client secret> – пароль для приложения (строго конфиденциальная информация), генерируется автоматически, недоступно для редактирования. Связка Client ID и Client secert представляют собой специальные учетные данные (credentials), которые используется для подключения к сервисам API.

• кнопку <Перегенерировать client secret> – при нажатии на которую производится генерация нового значения в поле <Client secret>.

• поле <Redirect URL> – для ввода URL-адреса, на который осуществляется перенаправление в процессе аутентификации клиента. Допускается использование нескольких Redirect URL, для добавления еще одного нужно нажать кнопку <Добавить Redirect URL> – при нажатии на которую добавляется еще одно поле <Redirect URL>.

• кнопку <Сохранить> – при нажатии на которую выполняется сохранение введенных данных и регистрация приложения на Платформе.

1. Заполнив форму регистрации приложения, нажать кнопку <Сохранить>. После сохранения данных приложение отображается в списке во кладку "Мои приложения".

Просмотр и редактирование данных приложения

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

1. Во вкладке "Мои приложения>" выбрать необходимое приложение.

2. Откроется форма с данными приложения.

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

Деактивация приложения

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

1. Во вкладке "Мои приложения" выбрать необходимое приложение.

1. В открывшейся форме нажать кнопку <Деактивировать приложение>.

2. Откроется форма подтверждения деактивации приложения, на которой нажать кнопку <Деактивировать>. Приложение будет деактивировано.

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

1. Мои API - отображает список API методов и статус их публикаций. В данной вкладке осуществляется непосредственно публикация API.

Публикация API

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

1. Раскрыть блок данных "Основная информация".

2. Ввести данные, описывающие публикуемый метод API, во вкладке "Информация".

1. Пройти тестирование API перед публикацией.

Для начала теста пользователь должен нажать на кнопку согласия на предоставление своего ИИН для проверки методов и нажать на кнопку <Запустить проверку>.

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

Не пройденные проверки выделяются красным цветом.

1. Если тесты прошли успешно, то становится активной кнопка <Опубликовать>, которую необходимо нажать для публикации API.

Во вкладке "Услуги" для опубликованного API изменится статус на "услуга активна".

Организация сетевого доступа:

• Тестовый стенд опубликован в сети Интернет. Перед публикацией API необходимо предоставить в АО "НПК" URL-адрес API, чтобы к нему был организован доступ.

• Доступ посредством выделенного канала на промышленной среде настраивается совместно, при этом обеспечивается консультация со стороны сетевых специалистов АО "НПК"

Перед запуском автоматических тестов необходимо убедиться, что параметры API настроены корректно ( см. )

1. Настройки API - предназначена для ввода информаций об API и конфигурирования публикуемых API.

Заполнение основной информаций

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

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

1. Раскрыть блок данных "Основная информация".

1. Заполнить сведения.

2. Нажать кнопку <Сохранить>.

Настройка публикуемых API

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

1. Раскрыть блок данных "Настройка API".

1. Ввести URL-адрес, по которому будут доступны публикуемые API.

2. Для сохранения настроек необходимо нажать кнопку <Сохранить>.

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

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

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

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