Введение

Чек-лист для проверки готовности к тестовой и промышленной интеграции

Чек-лист

Перечень доступных областей применения Alfa API

Scopes (области применения)

Как выбрать способ авторизации для получения доступа к продуктам и сервисам Alfa API

Авторизация

Применение криптографических преобразований для обеспечения надёжности передачи информации

Защита канала

Механизм версионирования методов Alfa API

Версионирование

Как разделить ответ на несколько страниц

Пагинация

Термины и определения документации Alfa API

Термины и определения

Для чего нужно устанавливать сертификаты Минцифры

Что это и для чего нужно

Как установить сертификаты Минцифры для Android

Сертификаты для Android

Как установить сертификаты Минцифры для iOS

Сертификаты для iOS

Как установить сертификаты Минцифры для Windows

Сертификаты для Windows

Как установить сертификаты Минцифры для MacOS

Сертификаты для MacOS

Как установить сертификаты Минцифры для Linux

Сертификаты для Linux

Как установить сертификаты Минцифры

Сертификаты Минцифры

Спецификация Alfa API. Основные принципы работы, защиты и области применения Alfa API

Общая информация

Пошаговая инструкция по подключению к Alfa API

Как подключить

Инструкция по подписанию договора на информационно–технологическое взаимодействие посредством Alfa API

Подписание договора

Инструкция по отзыву договора на информационно–технологическое взаимодействие посредством Alfa API

Отзыв договора

Client ID

Как выпустить TLS-сертификат

TLS-сертификат

Client secret

Подключение к Alfa API

Что такое и для чего нужен Портал разработчика

Для чего нужен

Как настроить права доступа для Портала разработчика в Альфа-Бизнес

Права доступа

Как настроить интеграцию для песочницы через Портал разработчика и протестировать её

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

Инструкция по созданию новых и редактированию текущих промышленных интеграций

Создание интеграции в проме

Как использовать API key для авторизации запросов в H2H-интеграциях

API Key

Инструкция по управлению интеграциями через Портал разработчика

Портал разработчика

Что такое Alfa ID и зачем он нужен

Что такое Alfa ID

Как пройти аутентификацию в Alfa ID

Аутентификация

Как добавить кнопку входа через Alfa ID

Кнопка входа по Alfa ID

Получение кода авторизации, токена доступа, информации о профиле представителя ЮЛ/ФЛ, проверка подписи, обновление или отзыв токена

Как использовать ACF

Как получить код авторизации для сценария Authorization Code Flow

Получение кода авторизации

Как получить токен доступа для сценария Authorization Code Flow

Получение токена доступа

Как получить информацию о профиле представителя ЮЛ/ФЛ для сценария Authorization Code Flow

Получение профиля представителя пользователя

Как обновить токен доступа для сценария Authorization Code Flow

Обновление токена доступа

Authorization Code Flow

Получение кода авторизации, токена доступа, обновление или отзыв токена для H2H-интеграций

Как использовать ACF для H2H

Как получить код авторизации для H2H-интеграций

Как получить токен доступа для H2H-интеграций

Как обновить токен доступа для H2H-интеграций

Authorization Code Flow для H2H-интеграций

Получение кода авторизации, токена доступа, обновление или отзыв токена для холдингов

Как использовать ACF для холдингов

Как получить код авторизации для сценария Authorization Code Flow для холдингов

Как получить токен доступа для сценария Authorization Code Flow для холдингов

Как обновить токен доступа для сценария Authorization Code Flow для холдингов

Authorization Code Flow для холдингов

Получение кода авторизации, проверка подписи и отзыв токена в H2H-интеграциях для вызова системных API без привязки к данным пользователя

Как использовать CCF

Как получить токен доступа для сценария Client Credentials Flow

Client Credentials Flow

Как проверить подпись для сценария Authorization Code Flow

Проверка подписи

Как отозвать токен доступа

Отзыв токена доступа

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

Данные по согласиям пользователей

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

Расширение сценариев

Как экранировать специальные символы

Экранирование

Зачем нужен Alfa ID. Аутентификация с помощью ALfa ID. Какие есть сценарии аутентификации для получения доступа к ресурсам Alfa API

Alfa ID

Подключение к Alfa API и настройка тестовой интеграции с Alfa API и Alfa ID

Тестирование вебхуков в песочнице

Инструкция по тестированию

Как проверить работу вебхука

Проверка работы вебхука

Как тестировать вебхуки в песочнице

Тестирование вебхуков

Как тестировать электронную подпись в песочнице

Тестирование электронной подписи

Как управлять сертификатами для подписи и шифрования в песочнице

Управление сертификатами для подписи и шифрования

Как тестировать подпись и шифрование сообщения в формате JSON

Формат исходного сообщения JSON

Как тестировать подпись и шифрование сообщения в формате XML

Формат исходного сообщения XML

Как тестировать подпись и шифрование сообщения в формате TXT

Формат исходного сообщения TXT

Как тестировать транспортную подпись и шифрование в песочнице

Тестирование транспортной подписи и шифрования

Как тестировать платёжные поручения в песочнице

Тестирование платёжных поручений

Как настроить тестовую интеграцию с Alfa API и Alfa ID. Как тестировать сервисы Alfa API в песочнице

Песочница

Что такое Java SDK и как им пользоваться

Для чего нужен SDK

Как подключить SDK к проекту

Подключение

Как выполнить инициализацию SDK

Инициализация

Как создать TrustStore и KeyStore в Java для инициализации SDK

Создание TrustStore и KeyStore

Как настроить SDK по выписке

SDK по выписке

Как настроить SDK для подписания сообщений

SDK для подписи

Набор готовых реализаций для интеграций с Alfa API. Как использовать Java SDK в своих проектах

Java SDK

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

Требования и ограничения

Как скачивать файлы при работе с методами Alfa API, которые предполагают скачивание файлов

Скачивание файла

Как загружать файлы при работе с методами Alfa API, которые предполагают загрузку файлов

Загрузка файла

Механизм для скачивания и загрузки файлов при работе с методами Alfa API, которые предполагают загрузку или скачивание файлов

Обмен файлами

Методы и логика формирования транспортной подписи и шифрования

Для чего это нужно

Как добавить новый сертификат

Добавление нового сертификата

Как получить все сертификаты партнёра

Получение сертификатов

Как изменить статус сертификата

Обновление сертификата

Как управлять сертификатами для подписи и шифрования

Формат исходного запроса application/json

Подписание JSON RSA-сертификатом

Подписание JSON ГОСТ-сертификатом

Формат исходного запроса application/xml

Подписание XML RSA-сертификатом

Подписание XML ГОСТ-сертификатом

Формат исходного запроса text/plain

Подписание TXT RSA-сертификатом

Подписание TXT ГОСТ-сертификатом

Инструкция по формированию транспортной подписи в различных форматах

Транспортная подпись

Шифрование JSON RSA-сертификатом

Шифрование JSON ГОСТ-сертификатом

Шифрование XML RSA-сертификатом

Шифрование XML ГОСТ-сертификатом

Шифрование TXT RSA-сертификатом

Шифрование TXT ГОСТ-сертификатом

Инструкция по шифрованию сообщений в различных форматах

Шифрование

Инструкция по подписанию и шифрованию сообщений алгоритмами ГОСТ и RSA. Методы управления сертификатами

Транспортная подпись и шифрование

Как подключить механизм информирования при наступлении в системе события, на которое подписан Партнёр API

Создание вебхука

Как редактировать вебхук

Редактирование вебхука

Удаление вебхука

Как получить информацию о вебхуке

Получение вебхука

Как получить список вебхуков

Получение списка вебхуков

Как реализовать партнёрский метод для получения вебхуков

Партнёрский метод для получения вебхуков

Сервис информирования при наступлении в системе события, на которое подписан Партнёр API

Вебхуки

Как получить список счетов, которые клиент открыл в банке-партнёре

Получение списка счетов клиента

Как запросить выписку по счёту клиента

Запрос выписки по счёту клиента

Как отправить выписки по результатам валютного перевода

Отправка выписки по результатам валютного перевода

Сервис для получения списка счетов и выписки клиента

Счета клиентов

Как запросить курс конвертации валют

Запрос курса конвертации валют

Как создать платёжное поручение по конверсии валют и отправить его в Банк-партнёр

Создание платёжного поручения по конверсии валют

Как запросить статус конвертации валют

Запрос статуса конвертации

Сервис для конвертации валют

Конвертация валют

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

Каталог готовых интеграций