Введение

Данная документация полностью покрывает всё взаимодействие с API сервиса.

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

Все выше перечисленные предупреждения применими как к API, так и нашему виджету, в дальнейшем он (виджет) появится в виде отдельного NPM пакета, который можно будет обновлять

В целях обратно совместимости, старые версии API будут рабоать в прежнем режиме и мы заранее предупредим, если они перестанут работать.

Варианты работы с API

Работа с API может происходить в двух вариантах

  • Используя виджет (рекомендуется)
  • Отправлять запросы напрямую к API (не рекомендуется)

В первом случае необходимо правильно инициализировать скрипт на странице, необходимо сделать отдельную HTML страницу и добавить туда наш скрипт

Пример инициализации скрипта

const app = new SLPWidget("API KEY","0000 0000 0000 0000",5003, {  redirect:"https://example.com",  API_VERSION:1,  mode:"production",});

При инициализаци скрипта, необходимо добавить слудующие аргументы:

  • API ключ, который можно получить снизу
  • Ваши реквизиты, куда должен поступить платёж
  • Объект дополнительных настроек

Во втором случае, необходимо отправлять запросы на сервер через доступные эндпоинты.

Ограничения API

  • API полностью открыто и любой может воспользоватсья им без генерации открытого ключа, в таком случае сервер принимает только тестовые запросы, не сохраняя данные формы и не выдавая данные для оплаты.
  • При создании открытого API ключа, необходимо указать домен (example.com) на котором будет использоваться. В таком случае, количество запросов увеличивается до 5ти (пяти) запросов в минуту.
  • В случае, если вам необходим полный доступ к API без ограничений, пожалуйста, свяжитесь с нами по почте support@soletspay.ru . Вы должны будете предоставить информацию, о целях использования нашего сервиса в масштабах, превышающих доступа по открытому ключу.

Работы с виджетом

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

Работа с запросами

Endpoint: /api/v2/form-submit

Данные отправляемые через post запрос (в т.ч. и API токен в заголовке Authorization):
{  "email": string,  "tel": string,  "first_name": string,  "last_name": string,  "requisites": string,  "cash": number}

Сервер возвращает данные, которые используются для оплаты:

{  "transaction_hash": string,  "card_number": string,  "phone_number": string,  "recipient": string}

Работа с запросами

Endpoint: /api/v2/payment-confirm

После получение номера карты и телефона, пользователь сам выбирает удобный ему способ перевода средств, либо по номеру карты, либо по номеру телефона через СБП. Независимо от выбранного варианта, пользователю необходимо так же отправить чек о произведении оплаты, дабы подтвердить, что данное действие было выполнено им лично.

{  "user_cheque": binary;}