Начало работы с API

Пoдключение

До начала интеграции вам нужно выполнить несколько шагов:

1. Создать аккаунт и магазин Feennex

2. [Подтвердить магазин(#verify-shop)

3. [Получить секретный ключ и настроить разрешенные IP-адреса(#secure-settings)

4. [Настроить формирование подписи в вашей системе(#sign)

5. Проинтегрироваться с Feennex по API

Создание аккаунта и магазина Feennex

Создание аккаунта Feennex

Если у вас нет аккаунта Feennex, зарегистрируйте его и пройдите верификацию. Теперь можно приступать к созданию магазина.

Создание магазина Feennex

Создайте новый магазин. От имени этого магазина вы будете отправлять запросы в Feennex. Укажите название вашего магазина и его URL-адрес. Нажмите Создать магазин.

После создания появится страница подтверждения магазина.

Подтвеpждение магазина

Обратите внимание! Этот шаг можно выполнить позже. Для этого нажмите Пропустить. Подтвердить магазин можно будет в личном кабинете в разделе Магазины.

Чтобы отправить запрос на активацию магазина и подключение методов оплаты, необходимо пройти верификацию домена.

Скачайте специальный файл и разместите его в корне вашего сайта на сервере или хостинге. Файл должен был доступен для загрузки. Пример: http://yourwebsite.com/fnx_0123.txt. Нажмите Подтвердить

Если всё прошло успешно - сайт отправлен на проверку. Для уточнения деталей вы можете обратиться в поддержку.

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

Если проверка прошла, откроется страница настроек созданного магазина. На этой странице вы можете управлять созданным магазином:

• Изменять параметры и настройки, необходимые для платежей и выплат
• Просматривать доступные методы приема платежей и выплат
• Управлять настройками безопасности

Настройка магазина Feennex

На странице настроек созданного магазина заполните поля ввода:

• URL уведомлений – URL-адрес, на который Feennex присылает [уведомления(#notifications) об успешной оплате

• URL rejected уведомлений – URL-адрес, на который Feennex присылает [уведомления(#notifications) о отклоненной оплате

• Success URL – URL-адрес, на который Feennex перенаправит плательщика после успешной оплаты

• Failed URL – URL-адрес, на который Feennex перенаправит плательщика после неуспешной оплаты

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

Feennex присваивает вашему магазину уникальный идентификатор shop_id. Он понадобится при проведении выплат.

Настройки безопаcности

Раздел Безопасность в личном кабинете содержит настройки вашего секретного ключа и список разрешенных IP-адресов.

Секретный ключ

Секретный ключ вы можете сгенерировать в личном кабинете или указать свой собственный.

Если вы хотите использовать собственный секретный ключ, убедитесь, что он соответствует следующим критериям:

• имеет длину не менее 8 символов
• содержит хотя бы одну цифру
• содержит прописные и заглавные буквы

Никому не передавайте секретный ключ вашего магазина. Этим ключом вы подтверждаете, что операции проводятся от вашего имени.

Разрешенные IP-адреса

В разделе IP адреса вам нужно в поле ввода указать IP-адрес, с которого вы будете отправлять запросы в Feennex. После этого нажмите на кнопку + (плюс).

Если IP-адресов несколько, вы можете добавить их за один раз. В качестве разделителя используйте ; (точка с запятой).

Фopмирование подписи

Для каждого запроса вам нужно формировать подпись с помощью вашего секретного ключа и передавать ее в параметре sign.

Секретный ключ отвечает за безопасность ваших данных. Храните его в защищенном месте и не публикуйте на сторонних ресурсах. Секретный ключ вы можете получить в личном кабинете в настройках магазина.

Как сформировать подпись

Шаг 1. Отсортируйте все обязательные параметры по алфавиту, приведите их к строковому типу данных и объедините в одну строку. В качестве разделителя используйте ":" (двоеточие). В конец строки добавьте ваш секретный ключ (без знака ":").

Обратите внимание! Есть особенности при передаче некоторых параметров:

• Обязательный параметр email включать в строку не нужно.

• При формировании подписи в параметре amount передавайте один знак после точки, если сумма целая или дробная часть кратна 10, например, 12.0. В остальных случаях передавайте два знака после точки, например, 12.01

Пример объединения параметров в одну строку для запроса на создание платежа

{amount}:{currency}:{payway}:{shop_id}:{shop_order_id}{secret_key}

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

Пример полученной строки

12.34:840:bank_usd:5:4126SecretKey01

Шаг 2. Рассчитайте SHA256 хэш полученной строки.

Пример HEX-представления подписи

c438896efecd63

Для онлайн проверки вы можете использовать онлайн сервис.

Пример формирования подписи на языке Python

# Обязательные параметры запроса для формирования подписи

secret = 'SecretKey01'   
data_required = {
    'amount': '12.34',
    'currency': '840',
    'payway': 'card_usd',
    'shop_id': '5',
    'shop_order_id': '4126',
}

# Дополнительные параметры запроса. В формировании подписи не участвуют

data_add = {
    'email': '[email protected]',
}

key = ':'.join([data_required[key] for key in sorted(data_required)]) + secret
sign = hashlib.sha256(key.encode()).hexdigest()

Шаг 3. Передавайте полученное значение в запросе в параметре sign.

Пример формирования подписи для запроса Создание платежа

{
  "currency": "840",
  "sign": "c438896efecd63",
  "payway": "bank_usd",
  "amount": "12.34",
  "shop_id": "5",
  "shop_order_id": 4126,
  "description": "Оплата заказа"
}

Интеграция с Feennex по API

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