API

1. Тестовое окружение
2. Проверка взаимодействия с API
3. Интеграция с сервисом Pulse Pay
3.1 Ввод средств посредством API интерфейса с платежным шлюзом
3.2 Ввод средств посредством API интерфейса

Для тестирования работы с API можно использовать тестовый сервер https://test.pulsepay.cc
Тестовый сервер во всём аналогичен рабочему.

Актуальная онлайн версия документации по API и инструменты для тестирования методов доступны по адресу: https://test.pulsepay.cc/swagger-ui/index.html#/

Каждый метод содержит описание для схемы входных параметров и ответов от сервера

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

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

1. Начать с проверки что вы можете вызвать метод GET не требующий авторизации со своего сервера

если вернется серверное время то все ОК, доступ по сети есть!

Pulse Pay использует стандартную схему JWT авторизации (документация: https://jwt.io/ и https://tools.ietf.org/html/rfc7519 ), то есть для работы с методами API вначале нужно запросить у сервера JWT токен, который уже будет использоваться в Bearer аутентификации.

Полученный токен нужно сохранить и использовать его для запросов. Не нужно создавать новый токен на каждый запрос!

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

Используя ваш email и пароль вам должен вернуться json ответ наподобие:

3. Полученный токен может быть использован как в свагере чтобы исполнять методы непосредственно из него для этого в свагере то нажмите кнопку [Authorize] в верхнем правом углу

и скопируйте в открывшийся диалог значение токена в поле value (без кавычек)

После этого в заголовок запросов будет добавляться токен - "Authorization: Bearer" + token и вы сможете исполнять защищенные методы непосредсвенно из UI свагера

4. Для того чтобы вызвать защищенные методы из кода нужно добавлять в заголовки ваших запросов полученный токен "Authorization: Bearer "

Пример:

Если после вызова метода вам возвращается ошибка 403 - это значит что вы указали неверно токен в своем запросе и вас не пускает

Сервис может быть использован для автоматического ввода средств

Для этого нужно:

1. Получить у поддержки api ключ и ключ rsa для вызова api, сообщить сallback url куда
будут приходить результаты исполнения ордеров

2. Сформировать GET запрос к шлюзу следующим образом

a) в значении параметра api указываете api ключ
б) в значении параметра data указываете результат шифрования json строки алгоритмом RSA следующего формата с использованием ключа rsa

Пример кода на java для шифрования:

Пример получившегося запроса:

После того как URL сформирован вы можете обратиться по нему к шлюзу Pulse Pay

Должно открыться окно следующего вида:

(внешний вид немного отличается для мобильной версии)

Если пользователь нажал кнопку [Далее] (не закрыв окно) его переносит на следующий этап ->

И финальный этап после оплаты выглядит так ->

На каждом этапе можно проверить статус запроса вызвав соответствующий рест метод

Возможны следующие статусы запроса:

Также статус запроса будет передан POST запросом на сallback url который указывали при регистрации

Для ввода средств без использования шлюза необходимо проделать следующие шаги:

1. Получить карту на которую нужно будет завести средства

Результат исполнения будет выглядить наподобие:

Далее есть возможность отменить запрос при необходимости:

Пример ответа:

Или сообщить что оплата прошла чтобы трейдеры быстрее подтвердили запрос

Пример ответа:

Как и в случае с интеграцией с использованием платежного шлюза статус запроса когда он будет рассмотрен трейдерами будет передан POST запросом на сallback url который указывали при регистрации