Подготовили шаблон интеграции Сбер ID для основных API.
\nВажно! Использование шаблона доступно только на десктоп версии Postman.
\nСопровождение Сбер ID: support_sberid@sber.ru
\nПолная документация доступна по ссылке
\n1.1. Скачайте сертифкат Минцифры на ваш компьтер с официального сайта по ссылке и добавьте его в Postman. Для этого в настройках выберете раздел \"Certificates\". Активируйте раздел \"CA certificates\" и укажите путь до сертификата с расширение .pem для MacOS.
\nДля работы с ИФТ стендом необходимо добавить в Postman сертификаты по ссылке ссылке
\n1.2. Скачайте полученный контейнер .p12 на ваш компьтер и извлеките из него сертификат и ключ, для этого в консоли используйте команды:
\nopenssl pkcs12 -in <имя вашего файла>.p12 -nodes -nocerts -out private.key\nopenssl pkcs12 -in <имя вашего файла>.p12 -clcerts -nokeys -out client_cert.crt\n\nПо итогу у вас в папке будет 2 файла \"private.key\" и \"client_cert.crt\"
\n1.3. Добавьте полученные файлы в Postman. Для этого в настройках выберете раздел \"Certificates\", нажмите кнопку \"Add Certificate...\".
\nВ окне укажите:
- Host \"oauth-ift.sber.ru\" для тестового контура и \"oauth.sber.ru\" для ПРОМа
- Укажите путь до файла с расширением \".crt\"
- Укажите путь до файла с расширением \".key\"
Нажмите кнопку \"Добавить\".
Добавление сертификатов выполнено, перейдем к интеграции!
Подробное описание смотрите в документации к запросу \"GET 1. Auth Code\"
\nПодробное описание смотрите в документации к запросу \"POST 2. Access token\"
\nПодробное описание смотрите в документации к запросу \"GET 3. Userinfo\"
\nПодробное описание смотрите в документации к запросу \"GET 4. Analytics\"
\nКаждый redirect_uri должен быть добавлен на стороне Сбер ID, для этого направьте нужные редиректы на почту support_sberid@sber.ru. Укажите стенд (тестовый/ПРОМ), ваш client id и перечень редиректов. Иначе вы будете получать ошибку \"Этот сервис не настроен для работы со Сбер ID\"
\nПеречень данных пользователя (scope) так же прописывается на стороне Сбер ID. Для увеличения набора данных направьте нужные скопы команде подключения. Иначе вы будете получать ошибку \"Этот сервис не настроен для работы со Сбер ID\"
\nОписание возможных ошибок при интеграции
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"🚀 Быстрый старт","slug":"bystryj-start"}],"owner":"10935182","collectionId":"a4886cd1-376a-49e3-9899-028edabfcfd5","publishedId":"2sA3Qqes13","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-05-24T08:12:02.000Z"},"item":[{"name":"1. Auth Code","event":[{"listen":"test","script":{"id":"c8ba9888-42dc-41e1-916d-5a3e77fe0c75","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f826f8be-d0ec-4a2f-88ac-e27be7a0c0fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://id-ift.sber.ru?response_type=code&client_type=PRIVATE&scope=openid name mobile&client_id=&state=ut8Ar4MUZEMDPIiD2ko914y37s0Q0VKJgxeCkU0yzTY&nonce=NfZscgwxPY7v0kYvuPfnFHA57bqHxQc3lV51Oiaxlo4&redirect_uri=http://localhost:3000/auth/sberid&display=page","description":"ВАЖНО! Для получения code необходимо перейти по полученному URL в браузере и выполнить вход тестовым пользователем. Выполнять GET запрос НЕ НУЖНО
\nПосле успешного входа будет выполнен редирект по адресу из параметра redirect_uri и к URL будут добавлены параметры state и code. Пример: http://localhost:3000/auth/sberid?state=af0ifjsldkj&code=407D83FB-23FB-4DD1-84C0-D4211E287FBF
\nВводите произвольный номер телефона и почту, в качестве проверочных кодов используется - 00000
\nПри необходимости вы можете передавть свои параметры или UTM метки, как это сделать описали в нашей официальной документации
\n","urlObject":{"protocol":"https","host":["id-ift","sber","ru"],"query":[{"description":{"content":"Константа, всегда передавать 'code'
\n","type":"text/plain"},"key":"response_type","value":"code"},{"description":{"content":"Константа, всегда передавать 'PRIVATE'
\n","type":"text/plain"},"key":"client_type","value":"PRIVATE"},{"description":{"content":"Наименование групп данных, на которые подписана система Партнера (выдается при регистрации системы в Банке). Значение openid является обязательным. При тестировании советуем использовать только параметр \"openid\"
\n","type":"text/plain"},"key":"scope","value":"openid name mobile"},{"description":{"content":"Client ID, который вы получили при регистрации приложения или от команды сопровождения
\n","type":"text/plain"},"key":"client_id","value":""},{"description":{"content":"Значение, включенное в запрос, которое также возвращается в ответе. Может быть строка любого контента. Для предотвращения подделки межсайтовых запросов используется генерируемое случайным образом уникальное значение. Максимальная длина строки 96 символов
\n","type":"text/plain"},"key":"state","value":"ut8Ar4MUZEMDPIiD2ko914y37s0Q0VKJgxeCkU0yzTY"},{"description":{"content":"Значение, включенное в запрос, которое также возвращается в ответе. Может быть строка любого контента. Для предотвращения подделки межсайтовых запросов используется генерируемое случайным образом уникальное значение. Максимальная длина строки 96 символов
\n","type":"text/plain"},"key":"nonce","value":"NfZscgwxPY7v0kYvuPfnFHA57bqHxQc3lV51Oiaxlo4"},{"description":{"content":"URL вашего сайта/приложения, на которую будет перенаправлен клиент после успешной аутентификации в системе Банка. Временное ограничение: недопустимы символы “;” и “=“. \nПример редиректа \"http://localhost:3000/auth/sberid?state=af0ifjsldkj&code=407D83FB-23FB-4DD1-84C0-D4211E287FBF\nВажно! Каждый редирект необходимо регистрировать в системе банка
\n","type":"text/plain"},"key":"redirect_uri","value":"http://localhost:3000/auth/sberid"},{"description":{"content":"Режим отображения страницы авторизации по Сбер ID (page - в текущем окне)
\n","type":"text/plain"},"key":"display","value":"page"}],"variable":[]}},"response":[],"_postman_id":"f826f8be-d0ec-4a2f-88ac-e27be7a0c0fd"},{"name":"2. Access token","event":[{"listen":"test","script":{"id":"5339ae3e-a031-447d-bf91-d33ddd801221","exec":[""],"type":"text/javascript","packages":{}}}],"id":"50573c74-de40-4858-9c7d-9eba0dcd152f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"content-type":true,"accept-encoding":true}},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"rquid","value":"7925a2d384094f5fae668de976942a55","description":"Уникальный идентификатор сообщения, «length=32 и pattern=([0-9][a-f][A-F])32)», переданный во входящем сообщении. Необходим для журналирования входящих вызовов и удобства разбора инцидентов.Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID(https://ru.wikipedia.org/wiki/UUID), убрав из результата разделители «-»
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"Константа, всегда передавать 'authorization_code'
\n","type":"text"},{"key":"code","value":"E5273746-9828-481B-BD51-154FFA6F62C5","description":"Параметр code, который получили в результате редиректа после успешного входа пользователя
\n","type":"text"},{"key":"client_id","value":"","description":"Client ID, который вы получили при регистрации приложения или от команды сопровождения
\n","type":"text"},{"key":"client_secret","value":"","description":"Client Secret, который вы получили при регистрации приложения или от команды сопровождения
\n","type":"text"},{"key":"redirect_uri","value":"http://localhost:3000/auth/sberid","description":"URL вашего сайта/приложения, на которую будет перенаправлен клиент после успешной аутентификации в системе Банка. Временное ограничение: недопустимы символы “;” и “=“. \nПример редиректа \"http://localhost:3000/auth/sberid?state=af0ifjsldkj&code=407D83FB-23FB-4DD1-84C0-D4211E287FBF\nВажно! Каждый редирект необходимо регистрировать в системе банка
\n","type":"text"}]},"url":"https://oauth-ift.sber.ru/ru/prod/tokens/v2/oidc","description":"При запросе токена в redirect_uri необходимо передавать тот же редирект, что был в запросе Auth Code. Редиректы должны совпадать символ в символ.
\nВажно! Редирект не должен содеражать ваши GET параметры и UTM метки, только URL.
\nTimeOut запроса - 10 сек.
\nпример ответа:
\n{\n \"access_token\": \"ce62db11-fa54-4def-9ff3-055c2c051317\",\n \"token_type\": \"bearer\",\n \"expires_in\": 300,\n \"scope\": \"birthdate email gender mobile name openid\",\n \"id_token\": \"eyJhbGciOiJub25lIn0.eyJzdWIiOiIyMGVlNGY4NzA5M2E1OGFlOTkxYTBmYzI5MTk1NDVmMjkyNDZmYjhhMjcwZDk0MDQ1Y2M3NDc3YzhjYzFmMzZmNDliMDI1MzU3OGYzZTkyMiIsImV4dGVybmFsX2lkZW50aWZpZXIiOiJrYWpkbGthc2RvQGtvd2V3ZS5vaSIsImlzcyI6ImlkLWlmdC5zYmVyLnJ1IiwiYXV0aF90aW1lIjoxNzQ5NTcxNzc3LCJpYXQiOjE3NDk1NzE3OTQsImV4cCI6MTc0OTU3MjA5NCwiYXVkIjoiOThGNTE3QjAtNjdBQy1CRjc4LTFEMTctRDI4NUMxOUUwNDE1Iiwibm9uY2UiOiJMaXdrZEtoSU9ockRLdkpYMnNndkI1eGtrRlVWMm02am5BWUszZlhUSFNFIn0.\"\n}\n\nУникальный идентификатор сообщения, «length=32 и pattern=([0-9][a-f][A-F])32)», переданный во входящем сообщении. Необходим для журналирования входящих вызовов и удобства разбора инцидентов.Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID(https://ru.wikipedia.org/wiki/UUID), убрав из результата разделители «-».
\n"},{"key":"Authorization","value":"Bearer {{vault:authorization-secret---uuid}}","description":"Передается токен полученный при обмене auth_code на access_token (в ответе на запрос №2 Access token)
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://oauth-ift.sber.ru/ru/prod/sberbankid/v2.1/userinfo","description":"Подробное описание запроса доступно на портале с официальной документацией
\nTimeOut запроса - 10 сек.
\nПример ответа:
\n{\n \"iss\": \"id.sber.ru\",\n \"sub\": \"20ee4f87093a58ae991a0fc2919545f29246fb8a270d94045cc7477c8cc1f36f49b0253578f3e922\",\n \"aud\": \"98F517B0-67AC-BF78-1D17-D285C19E0415\",\n \"birthdate\": \"1991-10-10\",\n \"email\": \"NEW@NEW.NEW\",\n \"family_name\": \"МИХАИЛ\",\n \"given_name\": \"МИХАИЛ\",\n \"phone_number\": \"+7 (911) 0000000\"\n}\n\nУникальный идентификатор сообщения, «length=32 и pattern=([0-9][a-f][A-F])32)», переданный во входящем сообщении. Необходим для журналирования входящих вызовов и удобства разбора инцидентов.Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID(https://ru.wikipedia.org/wiki/UUID), убрав из результата разделители «-».
\n"},{"key":"Authorization","value":"Bearer {{vault:authorization-secret---uuid}}","description":"Передается токен полученный при обмене auth_code на access_token (в ответе на запрос №2 Access token)
\n","type":"text"}],"url":"https://oauth-ift.sber.ru/api/v2/auth/completed","description":"При успешной авторизации пользователя, например, когда вы впустили его в пост-логин зону, необходимо отправить нам аналитическое событие о факте успешного входа.
\nДанная аналитика необходимо команде сопровождения Сбер ID для быстрой реакции на инциденты и повышения качества сервиса.
\nБез реализации отправки данной аналитики вход по Сбер ID может быть отключен в одностороннем порядке.
Пример ответа:
HTTP/1.1 204 No Content\n\n