Перейти к основному содержимому

Общая логика интеграции

Интеграция в Mandarin строится на API единой платежной формы. Этот механизм позволяет связать вашу систему с платежной страницей и автоматически создавать счета для клиентов.

Сценарий работы выглядит так:

  1. в личном кабинете создается платежная ссылка
  2. для ссылки настраивается API-интеграция

  1. создается API-ключ

  1. созданный API-ключ и идентификатор платежной ссылки используются в параметрах запроса
  2. дополнительно можно указать URL для получения асинхронного уведомления при изменении статуса созданного счета

4. ваша система отправляет запрос в Mandarin
5. на основе запроса создается счет
6. клиент переходит к оплате или оформлению
7. на указанный адрес отправляется уведомление о том что счет оплачен

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

Что дает интеграция

Интеграция позволяет:

  • автоматически создавать счета из внешней системы
  • передавать данные клиента и заказа без ручного ввода
  • управлять доступными способами оплаты
  • получать статусы счетов после оплаты
  • встроить платежный сценарий в уже существующую систему

Это решение подходит для любой системы, которая умеет отправлять API-запросы и принимать ответы.

Что передается в запросе

Запрос на создание счета через API единой платежной формы может содержать до четырех блоков данных.

1. Параметры заказа

В этом блоке передаются данные клиента и заказа, например:

  • email
  • телефон
  • номер заказа

2. Корзина

В блоке корзины передаются данные по товарам или услугам:

  • наименование
  • стоимость
  • НДС
  • описание

3. Ссылки и URL

В этом блоке можно передавать:

  • ссылку на оферту или юридическую информацию
  • ссылку для перехода после успешной оплаты
  • ссылку для перехода после неуспешной оплаты

4. Доступные способы оплаты

В запросе можно указать, какие способы оплаты будут доступны по счету, например:

Какие данные обязательны

Для базовой интеграции не обязательно передавать все четыре блока.

Минимально достаточно передать:

  • параметры заказа
  • корзину

Этого достаточно, чтобы создать счет и передать клиенту ссылку на оформление.

Все остальные параметры - доступные способы оплаты, ссылки, логотип будут автоматически настроены из параметров привязанной платежной ссылки. Это позволяет управлять интеграцией без привлечения разработки.

Как это работает на практике

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

Обычно процесс выглядит так:

  1. клиент выбирает товар или услугу
  2. ваша система формирует API-запрос
  3. Mandarin создает счет
  4. клиент переходит по ссылке на оплату
  5. после оплаты или оформления система получает обновленный статус

Это помогает сократить ручную работу и встроить платежный процесс в текущую инфраструктуру бизнеса.

Готовые модули

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

Доступны готовые решения для:

  • Skillspace
  • GetCourse
  • Tilda

Эти модули работают на базе API единой платежной формы и позволяют быстрее запустить прием оплат и оформление заявок.

Как проверить статус счета

После создания счета его статус можно отслеживать двумя способами.

Способ 1. Проверять статус вручную

Для этого используется отдельный публичный запрос, который позволяет проверить статус счета по его идентификатору.

Через этот метод можно получить:

  • текущий статус счета
  • статусы всех попыток оплаты
  • типы оплат внутри счета

Это удобно, если по одному счету было несколько операций, например частичная оплата, доплата картой или повторная попытка оформления.

Способ 2. Получать статус автоматически

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

Система может автоматически передавать:

  • новый статус счета
  • сумму
  • данные по изменению статуса

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

Где настраивается интеграция

Интеграция привязывается к платежной ссылке, созданной в личном кабинете.

Порядок настройки:

  1. в разделе «Ссылки» создается платежная ссылка
  2. внутри ссылки открывается блок API-интеграция
  3. в этом блоке создается API-ключ
  4. API-ключ связывает платежную ссылку с вашей системой

После этого через API можно создавать счета на основе этой ссылки.

Параметры интеграции в дальнейшем можно менять через настройки той платежной ссылки, к которой привязан API-ключ.

Что важно помнить

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

Когда использовать API-интеграцию

API-интеграция подойдет, если вы хотите:

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

Коротко

Интеграция в Mandarin позволяет создавать счета через API единой платежной формы. Для этого в личном кабинете создается платежная ссылка, к ней подключается API-ключ, а затем ваша система отправляет запросы на создание счетов. После этого можно передавать данные заказа, получать ссылку на оплату и отслеживать статус счета вручную или автоматически.