跳至主要內容

API 轉接器

總覽

最後更新:2026年9月5日

STOAR 的 API 轉接器讓您不必撰寫新的用戶端程式碼,就能串接既有的工具、ERP 與整合系統。本頁說明轉接器的運作方式、如何驗證,以及如何在管理後台管理它們。


總覽 #

STOAR 透過四個線路相容的 REST API 轉接器,開放同一份商品、訂單與顧客資料。每個轉接器都呈現一種熟悉的 API 形態,讓您既有的用戶端函式庫可以像連接原本開發時的平台那樣連接 STOAR——不需要修改任何程式碼。


可用的轉接器 #

轉接器 基礎 URL 相容對象
Magento /rest/V1 Magento 2 REST 用戶端
Shopify /admin/api/2024-01 Shopify Admin API 用戶端
WooCommerce /wp-json/wc/v3 WooCommerce REST v3 用戶端
BigCommerce /api BigCommerce v2/v3 用戶端

端點參考與請求/回應細節,請見各轉接器的文件:Magento · Shopify · WooCommerce · BigCommerce


驗證 #

四個轉接器都使用 Sanctum 個人存取權杖。要驗證一個請求,請將您的權杖以 Bearer token 的形式放進 Authorization 標頭:

Authorization: Bearer <your-token>

權杖在 後台 → REST API → API 權杖 建立與管理。建立權杖時您會指派一組能力,精確控制它可以存取哪些端點——例如 products:readorders:write。權杖可隨時撤銷,也可以選擇性設定存活時間(TTL),讓它自動到期。


流量限制 #

預設套用兩種流量限制:

  • 已驗證的請求(依權杖計算):每分鐘 60 次請求
  • 公開請求(依 IP 計算):每分鐘 10 次請求

兩種限制都可設定。您可以在 後台 → 設定 → API 設定 調整每分鐘上限,或完全開啟與關閉流量限制。

超過限制時,API 會回傳 429 Too Many Requests 回應。Retry-After 標頭會指出重試前需等待幾秒。


共用資料層 #

四個轉接器都讀取同一份底層的商品、訂單與顧客資料。每個轉接器只負責把這些資料轉換成自己的原生回應格式——沒有重複的記錄,也沒有同步需要管理。您在管理後台更新的商品,會立即反映在每一個轉接器上。


商店檢視 #

若您經營一個以上的商店前台,轉接器會遵循您的商店檢視設定。目前檢視由請求進入的網域決定,因此送往某個商店檢視自有網域的請求,會回傳該檢視的商品目錄——與商店前台採用相同的範圍界定。

未對應到任何商店檢視網域的請求,會回退到您的預設商店檢視,涵蓋完整商品目錄。因此不在意商店檢視的整合完全不需要改動。


管理 API #

前往 後台 → REST API 即可管理您的 API 設定:

  • 轉接器 — 檢視已註冊的轉接器及其 URL 前綴。
  • API 權杖 — 產生新權杖、指派能力、設定 TTL,並撤銷不再需要的權杖。
  • 設定 — 開啟或關閉流量限制,並為已驗證請求與公開請求設定每分鐘的請求上限。