Управление API Key

Портал разработчика позволяет управлять API Key – ключами доступа для упрощённой авторизации запросов в H2H-интеграциях. Подробнее о ключе и доступных по нему сервисах на странице API Key.

Для настройки авторизации с помощью API Key вам необходимо выпустить ключ для H2H-интеграции, скопировать его и вручную добавить в свои рабочие инструменты. Значение ключа передаётся в заголовке: Authorization: ApiKey {API Key}:

Пример запроса с использованием API Key

1curl -X GET https://baas.alfabank.ru/api/endpoint \
2  -H 'Authorization: ApiKey akytnps_YfSpCMb0_Uat5NX4p3c7A50hf27Qapk7nXYQ81h659tSwKml87xA5IhpBXXnpKSVypV60dI2l_2918090335' \
3  -H 'Accept: application/json' \
4  -H 'Content-Type: application/json'

Выпуск API Key для прома

Перед выпуском API Key для промышленной H2H-интеграции рекомендуется сначала пройти описанные ниже шаги для тестовой H2H-интеграции в рабочей среде «Песочница» и протестировать ключ, и только после этого приступать к выпуску ключа для промышленной H2H-интеграции.

Необходимые полномочия для выпуска ключа

Выпускать API Key необходимо пользователю, у которого в Альфа-Бизнес настроены соответствующие полномочия на использование выбранных при выпуске ключа продуктов и сервисов. Если у пользователя отсутствуют эти полномочия, руководителю организации необходимо выдать их пользователю в Альфа-Бизнес (в разделе Профиль – Пользователи и роли) или выпустить ключ самому.

Нажмите Выпустить API Key

Нажмите Выпустить ключ в правой части карточки H2H-интеграции.

Заполните данные для API Key

Укажите IP-адреса, с которых будут отправляться запросы с использованием API Key. Отправка запросов с использованием API Key будет доступна только с указанных IP-адресов.

Для одного API Key вы можете указать не более 20 IP-адресов. Укажите сервисы и продукты, доступ к которым вы хотите получать с помощью API Key. Вам будут доступны сервисы и продукты из набора scopes редактируемой H2H-интеграции, доступ к которым возможен с помощью API Key. Далее проверьте и сохраните внесённые изменения.

Скопируйте и сохраните API Key

Поcле завершения выпуска API Key вы получите уведомление. Скопируйте его и вручную добавьте в ваши рабочие инструменты так, чтобы при отправке запросов по H2H-интеграции в запросах передавался заголовок Authorization: ApiKey {API Key}.

Срок действия API Key неограничен, но ключ будет автоматически отозван, если с момента последнего запроса прошло более 30 дней.

В случае потери данных либо компрометации ключа / необходимости замены данных для ключа вы можете перевыпустить его. Также вы всегда можете отозвать API Key, если больше не хотите использовать упрощённый способ авторизации.

Перевыпуск API Key

Нажмите Перевыпустить API Key

Нажмите на три точки в правом верхнем углу карточки H2H-интеграции и выберите Перевыпустить API Key.

Отредактируйте данные для API Key

При необходимости отредактируйте данные для API Key. Далее проверьте внесённые изменения и нажмите «Перевыпустить».

Скопируйте и сохраните API Key

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

Отзыв API Key

Для отзыва ключа доступа нажмите на три точки в правом верхнем углу карточки интеграции, выберите Отозвать API Key и подтвердите свои действия. В результате отзыва ключа упрощённая авторизация будет недоступна. При необходимости вы всегда можете выпустить новый API Key.