首页
XtreamUIPro

教程

用连接器连接商店

让您的计费或商店平台自行创建和续期线路:一个 API 密钥、适用于您的平台的连接器、一笔测试订单,以及后续事件的 webhook。

完成后,在您的平台上付款的订单会创建一条线路,每次付款都会续期,无需进入仪表盘。您需要一个拥有积分及可销售套餐的分销商(reseller)账户,以及一个有连接器的平台——WHMCS、Blesta、WISECP、HostBill、ClientExec、FOSSBilling、Paymenter、带 WooCommerce 或 Easy Digital Downloads 的 WordPress、Odoo、PrestaShop、OpenCart、Magento、Dolibarr、ERPNext,或通过 webhook 桥接的 Shopify、Upmind 和 Invoice Ninja。

创建 API 密钥

用分销商账户登录并打开“API 密钥”。密钥只在创建时显示一次——请立即复制。为每个系统另外创建一个密钥,带名称和允许使用它的地址,这样可以吊销其中一个而不影响其他;连接器需要一个可写入的密钥,因此不要勾选只读标志。

分销商账户的“API 密钥”页面:密钥、各系统的附加密钥、webhook 和最近的调用。
分销商账户的“API 密钥”页面:密钥、各系统的附加密钥、webhook 和最近的调用。

选择连接器

打开“资源 → 所有连接器”并选择您的平台。其页面列出连接详情、安装步骤、“下载”按钮、用于校验文件的 SHA-256,以及该连接器的测试程度——有的在真实平台内运行过,有的只测试了核心部分。源代码是开放的;相同的文件也发布在连接器网站上。

“所有连接器”页面:每个平台一张卡片,显示其版本和测试程度。
“所有连接器”页面:每个平台一张卡片,显示其版本和测试程度。

安装到您的平台

校验校验和,然后按连接器页面所述安装文件:WHMCS、Blesta 或 FOSSBilling 的模块文件夹,WordPress 的插件上传,Odoo 的 addons 文件夹,OpenCart 的扩展安装器,等等。用于 Shopify、Upmind 和 Invoice Ninja 的 webhook 桥接是您自己托管的一个小型 PHP 应用。连接器只是用您的密钥调用 Reseller API:它能做您的账户能做的事,仅此而已。

WHMCS 连接器的页面:连接详情、安装步骤、下载及其 SHA-256。
WHMCS 连接器的页面:连接详情、安装步骤、下载及其 SHA-256。

配置

在连接器的设置中填入 API 服务器的地址(其 /reseller/v1 路径)和密钥,然后把您平台的每个商品映射到您的分组可销售的一个套餐。价格和付款留在您的平台上:面板不收款,也没有支付网关。

下一笔测试订单

在您平台的测试环境中订购该商品。连接器用套餐和请求 ID 调用 create_line;线路会出现在“线路”中,以套餐的时长作为到期时间,您的平台会收到其凭据。续期用它自己的请求 ID 调用 renew_line,因此网络错误后的重试绝不会重复扣费。“API 密钥”页面列出最近的调用,含操作、结果、错误代码、地址和连接器名称。

测试订单之后的“线路”页面:新线路,带有连接器所请求的套餐、到期时间和连接数。
测试订单之后的“线路”页面:新线路,带有连接器所请求的套餐、到期时间和连接数。

添加 webhook(可选)

在“API 密钥”页面,为您需要的事件添加一个 webhook 端点(您平台的 https 地址):line.created、line.renewed、line.enabled、line.disabled、line.deleted、line.expiring、line.expired、credits.low。每条通知都用创建时只显示一次的密钥签名(X-Xtream-Signature),并且绝不包含密码;“测试”按钮会立即发送一条。

相关帮助主题

后续教程