Главная
XtreamUIPro

Руководство

Подключите магазин через коннектор

Пусть ваш биллинг или торговая платформа сама создаёт и продлевает линии: ключ API, коннектор для вашей платформы, тестовый заказ и webhooks для всего, что происходит дальше.

В итоге оплаченный на вашей платформе заказ создаёт линию, а каждый платёж её продлевает — без панели управления. Вам нужны партнёрский аккаунт (реселлер) с кредитами и пакетами, которые он вправе продавать, и платформа с коннектором — WHMCS, Blesta, WISECP, HostBill, ClientExec, FOSSBilling, Paymenter, WordPress с WooCommerce или Easy Digital Downloads, Odoo, PrestaShop, OpenCart, Magento, Dolibarr, ERPNext, а также Shopify, Upmind и Invoice Ninja через мост webhook.

Создайте ключ API

Войдите с партнёрским аккаунтом и откройте API Key. Ключ показывается один раз, при создании, — скопируйте его сразу. Создавайте отдельный ключ на каждую систему, с названием и адресами, которым разрешено его использовать, чтобы один можно было отозвать, не затрагивая остальные; коннектору нужен ключ с правом записи, поэтому флаг «только чтение» оставьте выключенным.

Страница API Key партнёрского аккаунта: ключ, дополнительные ключи по системам, webhooks и последние вызовы.
Страница API Key партнёрского аккаунта: ключ, дополнительные ключи по системам, webhooks и последние вызовы.

Выберите коннектор

Откройте Resources → All Connectors и выберите свою платформу. На её странице указаны параметры подключения, шаги установки, кнопка Download, SHA-256 файла для проверки и степень проверенности коннектора — одни запускались внутри реальной платформы, у других проверялось только ядро. Исходный код открыт; те же файлы опубликованы на сайте коннекторов.

Страница All Connectors: по одной карточке на платформу с её версией и степенью проверенности.
Страница All Connectors: по одной карточке на платформу с её версией и степенью проверенности.

Установите его на своей платформе

Проверьте контрольную сумму и установите файл там, где указано на странице коннектора: в папку модулей WHMCS, Blesta или FOSSBilling, через загрузку плагина в WordPress, в папку addons Odoo, через установщик расширений OpenCart и так далее. Мост webhook для Shopify, Upmind и Invoice Ninja — небольшое PHP-приложение, которое вы размещаете сами. Коннектор лишь вызывает Reseller API с вашим ключом: он может то же, что ваш аккаунт, и не больше.

Страница коннектора WHMCS: параметры подключения, шаги установки, загрузка и её SHA-256.
Страница коннектора WHMCS: параметры подключения, шаги установки, загрузка и её SHA-256.

Настройте его

В настройках коннектора введите адрес сервера API (его путь /reseller/v1) и ключ, затем сопоставьте каждый продукт вашей платформы с пакетом, который может продавать ваша группа. Цены и оплата остаются на вашей платформе: панель не принимает денег и не имеет платёжного шлюза.

Оформите тестовый заказ

Закажите продукт в тестовой среде вашей платформы. Коннектор вызывает create_line с пакетом и идентификатором запроса; линия появляется в Lines со сроком пакета в качестве срока действия, а ваша платформа получает её учётные данные. Продление вызывает renew_line со своим идентификатором запроса, поэтому повтор после сетевой ошибки никогда не списывается дважды. Страница API Key перечисляет последние вызовы с действием, результатом, кодом ошибки, адресом и названием коннектора.

Страница Lines после тестового заказа: новая линия с пакетом, сроком действия и подключениями, которые запросил коннектор.
Страница Lines после тестового заказа: новая линия с пакетом, сроком действия и подключениями, которые запросил коннектор.

Добавьте webhooks (необязательно)

На странице API Key добавьте endpoint webhook (https-адрес вашей платформы) для нужных событий: line.created, line.renewed, line.enabled, line.disabled, line.deleted, line.expiring, line.expired, credits.low. Каждое уведомление подписано секретом, который показывается один раз при создании (X-Xtream-Signature), и никогда не содержит пароля; кнопка Test отправляет уведомление сразу.

Связанные темы справки

Следующие руководства