Обзор примеров интеграции

В этом разделе описаны примеры интеграции с платежным шлюзом HighHelp. Примеры предназначены для ускорения внедрения H2H-интеграции и демонстрируют базовый цикл работы с API:

  • формирование заголовков аутентификации и цифровой подписи;

  • отправку запросов к API;

  • обработку ответов и ошибок.

В текущей версии примеры используют подпись запросов по алгоритму RSA-SHA256. В составе примеров также присутствуют вспомогательные модули для работы с HMAC (формирование подписи запросов и проверка подписи оповещений).

Правила аутентификации и формирования подписи:

Общий сценарий первого платежа описан в разделе Быстрый старт.

Состав примеров

В текущей версии доступны следующие примеры:

Каждый пример:

  • использует единый подход к формированию подписи запросов (RSA-SHA256);

  • содержит минимальный рабочий код для выполнения оплаты и проверки статуса;

  • показывает базовую структуру проекта и работу с конфигурацией;

  • включает вспомогательные функции для нормализации данных и формирования подписи (RSA и HMAC), которые можно использовать в собственной интеграции.

Конкретный набор эндпоинтов и сценариев (создание платежа, получение информации о заявке и т.п.) описан в документации к каждому примеру.

Что иллюстрируют примеры

Примеры иллюстрируют типовой H2H-сценарий с аутентификацией по RSA:

  • загрузку конфигурации (идентификатор кассы, приватный RSA-ключ, базовый URL API, настройки оповещений);

  • формирование тела запроса на создание платежа;

  • нормализацию данных и формирование сообщения для подписи;

  • создание цифровой подписи и установку заголовков x-access-*;

  • отправку HTTP-запроса к API;

  • разбор ответа и базовую обработку ошибок;

  • проверку цифровой подписи оповещений.

Для интеграций, использующих HMAC, следуйте общим шагам из примеров и правилам из раздела Аутентификация и подпись запросов (HMAC), а также раздела Подпись оповещений (HMAC). Примеры содержат вспомогательные функции для HMAC.

Требования к окружению

Перед использованием примеров убедитесь, что:

  • у вас есть доступ к кабинету мерчанта и создана касса;

  • для кассы сгенерирована пара RSA-ключей (public/private) и в настройках кассы включен режим аутентификации по RSA;

  • при необходимости HMAC-интеграции согласуйте с прикрепленным специалистом переключение алгоритма подписи и получите HMAC-ключ;

  • вы можете выполнять запросы к https://api.hh-processing.com из вашего окружения;

  • установлены требуемые версии интерпретатора/движка для выбранного примера (PHP, Node.js или Python).

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

Технические требования и команды запуска для каждого примера указаны в:

Рекомендации по использованию

Рекомендуется:

  • сначала настроить тестовое окружение и выполнить базовый сценарий из раздела Быстрый старт;

  • затем развернуть и запустить пример на выбранном языке;

  • адаптировать пример под вашу инфраструктуру:

    • вынесите секреты (идентификатор кассы, ключи) в переменные окружения или отдельный конфигурационный файл;

    • доработайте обработку ошибок и логирование;

    • реализуйте собственную логику хранения и обработки статусов платежей.

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