Возможности
Сервис - client_id, принадлежащий определенному набору. Каждый сервис создается в рамках одного набора и наследует его права доступа.
Набор - группа прав доступа (scope), предназначенная для конкретного типа интеграции. Например, существуют наборы для взаимодействия с банком, приемом платежей и других целей. Полный перечень наборов и входя щих в них прав доступа приведен в инструкции.
Подписать заявление может только пользователь с полномочиями ЕИО.
1. Авторизуйтесь в СберБизнес
Ссылка на страницу авторизации в СберБизнес
2. Зайдите в Личный кабинет Sber API
В меню слева выберите Все продукты и услуги. На открывшейся странице найдите вкладку Сбербанк API и выберите Sber API.
В появившемся окне ознакомьтесь с информацией о продукте и нажмите Подключить.
3. Выберете один или несколько наборов
Выберете наборы, необходимые для подключения. Доступен выбор одного, нескольких или всех наборов одновременно.
4. Создайте заявление
Заполните заявление и укажите контактный телефон, электронную почту и ответственное лицо за настройку сервиса. Для добавления ответственного лица нажмите кнопку Добавить и из раскрывающегося списка выберите сотрудника из справочника или создайте нового.
Ознакомьтесь с условиями предоставления услуг и нажмите кнопку Создать.
5. Подпишите заявление
Подпишите документ с помощью СМС-кода или токена.
После подписания заявления Личный кабинет будет активирован, а заявление станет доступно в разделе Документы.
При отключении набора все связанные с ним client_id будут удалены.
Подписать корректирующее заявление может только пользователь с полномочиями ЕИО.
1. Создайте корректирующие заявление
Создайте корректирующее заявление на вкладке Документы с помощью кнопки Внести изменения.
2. Заполните корректирующие заявление
В корректирующем заявлении доступны следующие действия:
- Подключить или отключить набор API.
- Назначить или изменить сотрудника, ответственного за хранение ключевой информации.
После заполнения данных нажмите Создать, подпишите заявление, и оно автоматически отобразится на вкладке Документы.
Создать дополнительный сервис могут пользователи, чья учетная запись в СберБизнес соответствует одной из следующих характеристик:
- Учетная запись с полномочиями единоличного исполнительного органа;
- Учетная запись с ролью разработчика Sber API.
Чтобы создать дополнительный client_id для набора, на главной странице нажмите кнопку Добавить сервис, выберите нужный набор из списка и завершите действие нажатием кнопки Добавить.
Предоставьте доступ команде разработки
Разработчики получат только ту информацию, которая нужна им для интеграции.
О добавлении новых пользователей рассказали в этой инструкции.
На данный момент настройки для тестового сервиса можно запросить, отправив письмо на supportdbo2@sberbank.ru с указанием вашего client_id.
В Личном кабинете Sber API выберете сервис.
В блоке Параметры промышленного сервиса размещена вся необходимая информация.
Параметры сервиса:
- Наименование сервиса - название вашего client_id, которое будет отображено в согласии.
- Redirect_uri — ссылка на ресурс вашей компании, на который будет осуществляться возврат после прохождения авторизации;
- Client_id — уникальный идентификатор сервиса;
- Client_secret — авторизационный ключ сервиса;
- Scope для авторизации v1 — для выполнения авторизации по методу /v1/oauth/authorize;
- Scope для авторизации v2 — перечень операций доступных для использования в ссылке авторизации по методу /v2/oauth/authorize.
- Back_url - ссылка на ресурс вашей компании, на который пользователь возвращается после выполнения оп ределенного действия, такого как завершение оплаты.
Отправьте информацию вашим разработчикам
В блоке Параметры промышленного сервиса нажмите Отправить настройки.
В открывшемся окне укажите адрес электронной почты и нажмите Отправить.
Если необходимо, нажмите Скопировать настройки, чтобы скопировать настройки промышленного сервиса в буфер обмена.
Для изменения настроек промышленного сервиса отправьте запрос на почту технической поддержки supportdbo2@sberbank.ru с указанием вашего client_id.
Redirect_uri — ссылка на ресурс вашей компании, на который будет осуществляться возврат после прохождения авторизации.
1. Отредактируйте Redirect_uri
После авторизации в СберБизнес перейдите в Личный кабинет Sber API, выберете сервис и в параметрах промышленного сервиса нажмите карандаш рядом с параметром Redirect URI.
2. Укажите значение Redirect_uri и сохраните В открывшемся окне введите значение Redirect URI и нажмите Сохранить
Redirect URI может хранить в себе несколько значений - для этого после каждого значения необходимо ставить ";". В ссылке авторизации необходимо использовать только одно значение Redirect URI.
Обновленные данные Redirect URI отразятся в параметрах промышленного сервиса.
Back URL — ссылка на ресурс вашей компании, на который пользователь возвращается после выполнения определенного действия, такого как завершение транзакции или закрытие окна.
1. Отредактируйте Back URL
После авторизации в СберБизнес перейдите в Личный кабинет Sber API, выберете сервис и в параметры промышленного сервиса нажмите карандаш рядом с параметром Back URL.
2. Укажите значение Back URL и сохраните
В открывшемся окне введите значение Back URL и нажмите Сохранить
Back URL может хранить в себе несколько значений - для этого после каждого значения необходимо ставить ";". В ссылке переадресации (например, на платежное поручение) необходимо указать только одно значение Back URL.
Обновленные данные Back URL отразятся в параметрах промышленного сервиса
Для каждого сервиса можно выпустить несколько TLS-сертификатов. Выпуск нового сертификата не отменяет действие предыдущих — каждый из них сохраняет силу на протяжении всего своего срока действия.
TLS-сертификат, изданный банком, необходим для доступа к методам Sber API.
1. Сгенерируйте сертификаты шифрования
После авторизации в СберБизнес перейдите в Личный кабинет Sber API, выберете сервис. В блоке Сертификаты шифрования нажмите кнопку Сгенерировать сертификат. Рядом с кнопкой отобразится количество доступных для генерации сертификатов.
2. Установите пароль доступа
В открывшемся окне укажите пароль доступа к сертификату.
Требования к паролю:
- Содержит минимум 7 символов;
- Содержит цифры и буквы;
- Не содержит трех одинаковых символов подряд.
4. Нажмите Создать сертификат
После успешной генерации TLS-сертификата в окне появится подтверждение и ссылка на скачивание файла сертификата. Нажмите Скачать файл сертификата.
Сгенерированные сертификаты появятся в блоке Сертификаты шифрования. Нажмите на иконку Скачать, чтобы скачать уже сгенерированные сертификаты.
Чтобы скачать цепочку доверенных TLS-сертификатов, нажмите ссылку "Скачать" в нижней части блока Сертификаты шифрования.
Чтобы отозвать TLS-сертификат, отправьте запрос на электронный ящик технической поддержки supportdbo2@sberbank.ru.
Client_secret - авторизационный ключ сервиса. Срок действия client_secret составляет 40 дней обновить значение можно методом /v1/change-client-secret или в личном кабинете Sber API.
Изменить client_secret могут пользователи, чья учетная запись в СберБизнес соответствует одной из следующих характеристик:
- Учетная запись с полномочиями единоличного исполнительного органа;
- Учетная запись с единственной подписью;
- Учетная запись с первой подписью;
- Учетная запись с ролью разработчика Sber API.
1. Откройте Параметры промышленного сервиса
В личном кабинете Sber API , выберете сервис.
2. Обновите Client_secret
В поле Client_secret нажмите кнопку Обновить. В открывшемся окне подтвердите генерацию client_secret по клику Сгенерировать.
После генерации Client_secret отображается только один раз. Скопируйте его и сохраните для дальнейшего использования при отправке запросов.
В личном кабинете можно сгенерировать токены: access_token (срок действия 30 дней, используется для авторизации запросов) и refresh_token (срок действия 180 дней, нужен для обновления access_token).
Важно: данная продолжительность "жизни" токенов относится только к парам, выпущенным напрямую в личном кабинете. Одновременно может быть активно не больше 3-х пар токенов на сервис (ограничение действует только в ЛК).
После получения пары, токен можно обновлять методом /ic/sso/api/v2/oauth/token, после обновления срок действия access_token изменится на 60 минут, а новая пара отобразится в личном кабинете с новым сроком действия.
Получить пару
1. Ключи доступа
В личном кабинете Sber API , выберете сервис.
2. В блоке Ключи доступа нажмите кнопку Сгенерировать ключ.
Подтвердите действие СМС-кодом. После подтверждения в течении 3-х минут вам доступна функциональность по созданию и обновлению токенов без повторного подтверждения.
После создания скопируйте токены, так как далее они замаскируются и потребуется повторное создание или обновление для отображения.
Раздел Мои ключи
Полученные токены отобразятся в разделе Мои ключи.
Обновить или Удалить токены можно с помощью соответствующих иконок напротив записи о ключе.
Удаление access_token, выпущенных другими сотрудниками организации, доступно только для пользователя ЕИО.
Раздел Мои ключи у другого пользователя
Раздел Мои ключи отображается по-разному в зависимости от пользователя:
- Если пользователь — владелец ключей, он видит те ключи, которые выпустил сам. Для каждого ключа отображается замаскированные значения, срок действия и доступные действия (обновление, удаление).
- Если пользователь не владелец ключей, в этом разделе он увидит ключи, выпущенные другими сотрудниками. В таком случае для каждого ключа указывается не только срок действия, но и владелец (ФИО). В зависимости от уровня доступа такой пользователь может управлять чужими ключами — обновлять или удалять их.
В разделе «Документы» отображаются подписанные заявления на подключение к Sber API, а также корректирующие заявления. Эти документы появляются там, только если они были подписаны непосредственно в личном кабинете. Если же договор или заявление подписывались через внешние системы ЭДО или в бумажном виде, они в этом разделе не отобразятся — их можно запросить у технической поддержки supportdbo2@sberbank.ru.
