Авторизация

Обзор

Сервис, позволяющий клиентам банка авторизоваться в стороннем приложении, используя надежно защищенный канал. Реализован с помощью протокола OAuth 2.0 и представлен типом авторизации Password Grant

Как начать?

Зарегистрируйтесь и авторизируйтесь на портале

Создайте приложение и выберите тип авторизации

Протестируйте выбранный тип авторизации

Получите промышленный доступ к любым непубличным API

Авторизуйте клиентов банка в вашем приложении по протоколу OAuth 2.0

Зарегистрируйтесь и авторизируйтесь на портале

Создайте приложение и выберите тип авторизации

Протестируйте выбранный тип авторизации

Получите промышленный доступ к любым непубличным API

Авторизуйте клиентов банка в вашем приложении по протоколу OAuth 2.0

Зарегистрируйтесь и авторизируйтесь на портале

Впервые на портале Alfa Developer Hub?

Заполните поля формы регистрации
Ознакомьтесь с условиями соглашения и отметьте флажок согласия
Подтвердите, что вы не робот :)

Уже есть аккаунт?

Воспользуйтесь своим логином и паролем для входа в личный аккаунт на портале

Создайте приложение и выберете тип авторизации

Быстро, просто, безопасно

Назовите и опишите приложение. Название приложения должно быть уникальным
Выберите тип авторизации, при необходимости укажите Redirect URL

Протестируйте выбранный тип авторизации

Описание сервиса первичной регистрации и аутентификации для физических лиц

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

Получите ключи Client ID и Client Secret (странница Приложения, вкладка Sandbox keys для тестовых ключей, вкладка Production keys для промышленных ключей)

Важно! Ваши ключи Client ID и Client Secret идентифицируют вас и необходимы для защиты себя и ваших клиентов. Держите их в очень безопасном месте

Регистрация клиента на стороне банка

Регистрация клиента Альфа-Банка физического лица происходит в партнерском приложении, где клиент передает в банк свои персональные данные, логин, пароль и подтверждает регистрацию при помощи смс-сообщения.

ШАГ 1: Клиент передает в банк через партнерское приложение свои персональные данные

* Примечание! При тестировании запроса регистрации в поле personId или в поле documentNum необходимо передавать значение «TEST»

Пример запроса:

POST/individual/1.0.0/registration/registration

Host: https://developerhub.alfabank.by:8273
Content-Type: application/json
{
"personId"="personId",
"deviceId"="deviceId",
"documentNum"="documentNum",
"issueDate"="issueDate",
"isResident"="isResident"
}

* Примечание! В запросе необходимо передавать параметр personId (личный номер паспорта резидента или нерезидента), если есть личный номер паспорта либо параметры documentNum (номер документа, максимальная длина – 13 символов) и issueDate (дата выдачи документа в формате YYYY-MM-DD), если личного номера паспорта у клиента нет. Параметр deviceId – ID устройства. Должно принимать значение KSUID (глобальный уникальный идентификатор, содержащий компонент времени). Параметр isResident – признак резидентности (булевое значение).

В случае успеха пользователю отправится смс на номер телефона и сервер вернет ответ:

{
"status": "OK"
}

ШАГ 2: Клиент подтверждает регистрацию и задает логин и пароль

* Примечание! При тестировании запроса подтверждения регистрации необходимо в поле login передавать значение «API»

Пример запроса:

POST/individual/1.0.0/registration/confirmRegistration

Host: https://developerhub.alfabank.by:8273
Content-Type: application/json
{
"sms"="sms",
"login"="login",
"password"="password",
"deviceId"="deviceId",
"approve"="true"
}

* Примечание! В запросе необходимо передавать в переменной approve значение true, означающее согласие пользователя на предоставление персональных данных партнерскому приложению.

Важно! В случае хранения партнерским приложением пары логин/пароль на устройстве, должно быть обеспечено их безопасное хранение в зашифрованном виде.

В случае успеха сервер вернет ответ:

{
"status": "OK"
}

В результате пользователь успешно зарегистрирован в системе.

Password Grant

Получение токена доступа происходит путем обмена пары логин/пароль на сам токен доступа.

Важно! Метод авторизации password grant предоставляет доступ только к сервисам на чтение информации.

ШАГ 1: Запрос получения токена доступа

* Примечание! При тестировании данного типа авторизации в поле username необходимо передавать значение «API».

Пример запроса:

POST/token

Host: https://developerhub.alfabank.by:8273
Content-Type: application/x-www-form-urlencoded
grant_type=password
&username=login
&client_id=clientId
&client_secret=secretId
&password=password
&scope=accounts_individual
&source=individual

* Примечание! В параметр source передается константа «individual». Параметр grant_type принимает значение «password», а в параметр password требует передачи пароля, который пользователь указал при регистрации.
Параметр scope в запросе предназначен для указания сервисов, к которым приложению необходимо получить доступ.

В случае успеха сервер вернет ответ:

{
"access_token": "access_token"
"token_type": "Bearer"
"expires_in": 900
"refresh_token": "refresh_token"
"scope": "accounts_individual"
}

Полученный токен используется для доступа к API.

Важно! В ходе опытно-промышленной эксплуатации для наших партнеров 100 вызовов в минуту на каждый API. При необходимости расширить установленный лимит вызовов API, просим высылать Ваши пожелания на эл. адрес api@alfa-bank.by.

Получите промышленный доступ к любым непубличным API

Откройте возможности вашего продукта клиентам

Заполните форму заявки на получение промышленного доступа к Alfa API
Представитель банка свяжется с вами и организует встречу для заключения договора о предоставлении промышленного доступа

Авторизуйте клиентов банка в вашем приложении по протоколу OAuth 2.0

Используйте промышленные ключи созданного вами приложения при формировании запроса на получение токена доступа. Стройте процесс авторизации с учетом использования приложения клиентами Альфа-Банка под своими учетными данными.