Инструкция для интеграции по API

Как происходит интеграция сервиса по API?

Подключение сервиса рассрочки и кредитования для покупателей состоит из трех этапов:

Ниже — пошаговые инструкции к каждому этапу.

Для интеграции нужен разработчик.

Как подготовиться к интеграции по API с банком?

Следуйте этой инструкции:

Подключите сервис кредитования покупателей.
Получите доступы и информацию для начала работы. Вот что нужно подготовить
Определитесь, нужно ли вам автоподтверждение. Эта функция подойдет магазинам, которые всегда готовы выдать товар: им не нужно проверять наличие на складе и сверяться с системой учета. Остальным можно выбрать ручное подтверждение через личный кабинет агента или с помощью API.
Автоподтверждение можно включить в личном кабинете руководителя: перейдите в «Кредитование в магазинах» → выберите магазин → «Редактировать». Поставьте галочку в блоке «Автоподтверждение интернет-заказов». Чтобы выключить автоподтверждение, просто уберите галочку.
Если вы хотите отслеживать статус заказа, подпишитесь на уведомления — вебхуки. Для этого укажите URL-адрес для вебхуков в личном кабинете руководителя.
Если адрес не меняется, впишите его в личном кабинете: «Кредитование в магазинах» → выберите магазин → «Редактировать» → «Уведомления» → «Адрес для HTTP-нотификаций». Поставьте галочку в чекбоксе.
Если адрес меняется, передайте его при создании заявки через метод Create в поле webhookURL. На этот адрес вы будете получать уведомления от банка. Какие вебхуки используются в интеграции
Укажите адрес конкретной страницы, на которую будете перенаправлять покупателей после заполнения заявки. Это можно сделать в личном кабинете руководителя.
Можно выбрать разные сценарии для перенаправления покупателя:
— при одобрении заявки покупатель увидит страницу, которую вы впишете в поле successURL;
— при отказе от банка — страницу failURL;
— при отмене заявки клиентом — страницу returnURL.
Если таких страниц нет, ничего не вписывайте. Тогда после одобрения или отказа покупатель увидит главную страницу сайта, на котором оформлял заказ.

Подготовка к интеграции завершена. После этого можно переходить к следующему этапу.

Как провести интеграцию по API?

Прежде чем начинать продажи в рассрочку или кредит, проверьте работу сервиса на вашем сайте.

Тестирование:

Создайте заявку. Используйте CreateDemo — метод для создания тестовых заявок. Какие методы API используют для интеграции
Тестовые заявки не отправятся в банк, но вы сможете посмотреть, как работает заполнение и что увидят ваши покупатели. Для создания тестовой заявки используйте shopID, showcaseID и promocode, которые получили на этапе подготовки.
Заполните заявку любыми данными, чтобы проверить работу формы и протестировать уведомления:
— заполните заявку и получите одобрение — придет вебхук approved;
— после одобрения заявку можно подписать любым СМС-кодом — придет вебхук signed.
— заполните заявку и получите отказ — придет вебхук rejected.
Какие уведомления используют в интеграции
Проверьте, как работает подтверждение заказа в тестовом режиме: «С автоподтверждением» и «Без автоподтверждения». Как работать с заявкой

После тестирования можно приступать к интеграции и продажам. Чтобы создавать реальные заявки, вам понадобится метод Create.

Интеграция и старт продаж:

Для создания реальных заявок используйте метод Create. Такие заявки отправятся в банк. Примеры запросов для интеграции API
Для работы с методом Create используйте боевые параметры из личного кабинета руководителя. Какая информация нужна для начала работы
Задать пароль для интеграции по API можно через личный кабинет руководителя: «Кредитование в магазинах» → выберите магазин → «Настройки API».
Расскажите своим покупателям о новом способе оплаты — в рассрочку или кредит — любым удобным вам способом

Готово! Теперь можно переходить к работе с заявками.

Как работать с заявкой?

Следуйте этой инструкции:

Покупатель оформляет заказ и по кнопке «Купить в кредит» переходит к заявке на рассрочку или кредит.
Покупатель заполняет заявку. Банк в течение одной-двух минут принимает решение и сообщает о нем покупателю: он увидит решение на той же странице с заявкой. Также решение по заявке придет покупателю по СМС или эл. почте, если он указывал адрес при оформлении заявки.
В личном кабинете агента статус заявки поменяется на «Одобрено», если банк принял положительное решение, или «Отказано банком», если отрицательное. На эл. почту из личного кабинета руководителя придут нотификации approved или rejected. Какие уведомления используют в интеграции
Если был указан URL для нотификаций, они продублируются и туда.
Если заявку одобрили, покупатель подписывает договор доступным ему способом: по СМС или на встрече с представителем.
Банк сообщит вам о подписании договора по эл. почте и в личном кабинете агента с помощью нотификации signed.
Если вы хотите запросить информацию по заявке сами, используйте метод info. Какие методы API используют для интеграции
Если у вас включено автоподтверждение, после подписания договора банк переведет деньги на счет магазина автоматически. Подтверждение или отмена заявки вручную недоступны с включенным автоподтверждением.
Если автоподтверждение выключено, вам нужно вручную подтвердить выдачу товара в личном кабинете. Если вы не можете выдать покупателю товар или услугу, отмените заявку. Статус заявки поменяется в личном кабинете агента.
Когда заявка будет подтверждена, банк переведет деньги на счет магазина. Методы commit и cancel недоступны для работы с автоподтверждением. То есть вы не сможете подтвердить заявку вручную. Для методов info, commit, cancel используйте пароль, который необходимо задать через личный кабинет руководителя.

Данные для тестирования

В качестве логина для метода надо передавать ваш идентификатор магазина с префиксом demo-. Например, если идентификатор — my-shop, при работе с демозаявкой надо передать логин demo-my-shop.