首頁
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 Key。金鑰只在建立時顯示一次——請立即複製。為每個系統另外建立一個金鑰,附上名稱與允許使用它的位址,這樣可以撤銷其中一個而不影響其他;連接器需要一個可寫入的金鑰,因此不要勾選唯讀旗標。

合作夥伴帳號的 API Key 頁面:金鑰、各系統的附加金鑰、webhook 與最近的呼叫。
合作夥伴帳號的 API Key 頁面:金鑰、各系統的附加金鑰、webhook 與最近的呼叫。

選擇連接器

開啟 Resources → All Connectors 並選擇您的平台。其頁面列出連線詳細資料、安裝步驟、Download 按鈕、用於驗證檔案的 SHA-256,以及該連接器的測試程度——有的在真實平台內運行過,有的只測試了核心部分。原始碼是開放的;相同的檔案也發布在連接器網站上。

All Connectors 頁面:每個平台一張卡片,顯示其版本與測試程度。
All Connectors 頁面:每個平台一張卡片,顯示其版本與測試程度。

安裝到您的平台

驗證檢查碼,然後依連接器頁面所述安裝檔案: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;線路會出現在 Lines 中,以方案的時效作為到期日,您的平台會收到其憑證。續期以它自己的請求 ID 呼叫 renew_line,因此網路錯誤後的重試絕不會重複扣費。API Key 頁面列出最近的呼叫,含動作、結果、錯誤代碼、位址與連接器名稱。

測試訂單之後的 Lines 頁面:新線路,帶有連接器所要求的方案、到期日與連線數。
測試訂單之後的 Lines 頁面:新線路,帶有連接器所要求的方案、到期日與連線數。

新增 webhook(選用)

在 API Key 頁面,為您需要的事件新增一個 webhook 端點(您平台的 https 位址):line.created、line.renewed、line.enabled、line.disabled、line.deleted、line.expiring、line.expired、credits.low。每則通知都以建立時只顯示一次的密鑰簽章(X-Xtream-Signature),並且絕不包含密碼;Test 按鈕會立即傳送一則。

相關說明主題

後續教學