1

Изучение API

  • Перейдите в API-каталог
  • Ознакомьтесь с полным перечнем сервисов
  • Изучите разделы: «Обзор», «Гайды», «Документация»

Что такое API Банка?

API банка — это интерфейс взаимодействия между нашим программным обеспечением и сторонними программами/серверами.

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

API обеспечивает быстрый, согласованный и надежный способ обмена данными.

Публичные API – это?

Публичные API – это сервисы, предоставляющие общедоступную информацию, а именно: актуальные курсы валют Альфа-Банка и Национального банка Республики Беларусь, а также коды банков Республики Беларусь и Российской Федерации.

2

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

  • Перейдите на страницу «Вход/Регистрация»
  • Заполните все поля формы
  • Внимательно ознакомьтесь и подтвердите условия использования API
  • После успешного прохождения процесса регистрации вы будете перенаправлены на страницу «Мои приложения»
3

Создание приложения

  • Перейдите на страницу «Мои приложения»
  • Начните создание по кнопке «Создать приложение»
  • Укажите уникальное имя
  • Добавьте краткое описание
  • Выберите тип авторизации Code Grant или Password Grant:
    • Для типа авторизации Code Grant укажите Redirect URL - это адрес, на который сервис перенаправит пользовательский агент (браузер) вместе с кодом авторизации
    • Для типа авторизации Password Grant не требуется Redirect URL
  • Перейдите к следующему шагу и подпишитесь на те сервисы, которые вы планируете использовать в своем приложении

Code Grant - это?

  • Code Grant - процесс авторизации, который строится на перенаправлении (redirection) на страницу на стороне банка для ввода пары логина/пароля и подтверждения прав, запрашиваемых приложением. Результатом данной операции является код авторизации, который клиент в последующем меняет на токен доступа. Является предпочтительным способом, так как доступ приложения к учетным данным пользователя исключен

Password Grant - это?

Password Grant - процесс авторизации, при котором предоставление сервером токена доступа происходит после передачи клиентом его ключа API, который был предварительно сгенерирован в личном кабинете Интернет-банка 2.0. Фактически, клиент сразу проходит как авторизацию, так и аутентификацию

4

Получение тестовых ключей

  • Перейдите на страницу созданного приложения
  • Откройте вкладку «Sandbox» для получения тестовых ключей

Client ID и Client Secret – это?

Сlient_id является открытым идентификатором приложения. Он уникален для всех клиентов.

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

5

Авторизация пользователя

Могу ли я получить доступ к API и вести разработку, не являясь клиентом Альфа-Банк?

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

Кто сможет использовать мое приложение?

Пользоваться вашим приложением смогут клиенты Альфа-Банка, имеющие учетную запись в Альфа-Бизнес Онлайн/Альфа-Бизнес Мобайл

Как я могу управлять 2FA (Two-Factor Authentication)?

В целях повышения безопасности для канала Open APi и конечных пользователей при авторизации по Code Grant по умолчанию включена 2FA. Первым фактором является логин и пароль. Второй фактор - код подтверждения в смс.

Пользователь может отключить 2FA в разделе "Настройки" в Альфа-Бизнес Онлайн.

6

Тестирование

  • Выполняйте тестовые вызовы сервисов в «Sandbox» на страницах документации
  • Тестируйте из своей среды разработки, выполняя вызовы сервисов непосредственно из вашего кода, используя ключи Client ID и Client Secret и учетные данные демо-пользователя (подробнее в API-Каталог > Авторизация > Гайды)
  • Используйте swagger-файл для упрощения процесса разработки

Что такое «Sandbox»?

«Sandbox» - это интерактивная документация, позволяющая выполнять вызовы сервисов API в тестовом режиме прямо с портала. Доступно для авторизованных пользователей.

Есть ли ограничение вызовов API?

Да, на текущий момент установлено ограничение вызовов на каждый сервис - не более 100 запросов в секунду, вне зависимости от режима использования (тестового/промышленного). То есть в течение одной секунды можно отправить только 100 запросов, при отправке сверх установленного лимита будет получен отказ (ошибка 429). При этом нет разницы, последовательно или параллельно они были отправлены.

Для увеличения лимита отправьте запрос на api@alfa-bank.by

7

Промышленный доступ

Чтобы использовать API для работы с реальными данными, вам понадобится промышленный доступ:
  • Перейдите на страницу «Мои приложения»
  • Нажмите на кнопку «Получить промышленный доступ»
  • Заполните и отправьте заявку, в ближайшее время с вами свяжется сотрудник банка
  • Пройдите простую процедуру оформления доступа к API

Какие документы необходимо предоставить?

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

8

Получение промышленных ключей

  • После предоставления промышленного доступа откройте вкладку «Production Keys» на странице созданного приложения
  • Используйте полученные ключи для перехода из режима тестирования к промышленной эксплуатации вашего программного обеспечения

Какая взимается плата за пользование Open API?

Open API предоставляется бесплатно.

9

Использование API в полную силу

  • Перенесите промышленные ключи Client ID и Client Secret в код своего приложения
  • Используйте все возможности вашего программного обеспечения
10

Поддержка пользователей

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

Куда звонить разработчику, если у него возникнут вопросы по настройке?

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

Телефон технической поддержки +375172297444.

Кому направлять пожелания или коммерческие предложения?

Ваши пожелания и предложения, в том числе по доработке/разработке сервисов можно направлять на адрес api@alfa-bank.by