開發者專區
這一頁說明 UberPrints 目前對外開放的程式介面:給合作店家串接自家系統的訂單事件 Webhook,以及給 AI agent 讀取本站內容的機器可讀入口。所有規格以本頁與後台畫面為準。
訂單事件 Webhook(Max 方案)
訂單事件 Webhook 是 Max 方案的功能。訂單在平台上發生狀態變化時,平台會主動 POST 事件到你指定的 URL,讓你把訂單推進自己的 ERP、通訊軟體或自動化流程,不需要輪詢。
設定位置在後台 /dealer/webhooks:新增一組 Webhook URL、勾選要訂閱的事件,系統會產生一組 secret。同一頁可以發送測試事件,也可以看最近的投遞紀錄與回應狀態。
事件清單
- order.created
- 客戶完成下單時觸發。
- order.review.passed
- 經銷商在後台點「審稿通過」時觸發。
- order.review.rejected
- 經銷商在後台點「審稿拒絕」時觸發。
- payment.received
- 用戶完成付款(信用卡 / 餘額扣款 / 線下匯款確認)時觸發。
- order.status_changed
- 訂單後續狀態轉換時觸發,包含已出貨 / 已送達 / 已完成 / 已取消。
- webhook.test
- 你在後台按「發送測試」時觸發,用來驗證端點與簽章。
請求格式與簽章驗證
- 方法與內容型別:HTTP POST,body 為 JSON。
- 事件名稱在 request header `X-Webhook-Event`。
- 簽章在 request header `X-Webhook-Signature`:以該 Webhook 的 secret 對「原始 request body」做 HMAC-SHA256,輸出 hex 字串。
- 請務必驗簽再信任 payload:用同一組 secret 重算 HMAC,並以固定時間比較(timing-safe compare)比對,不相符就丟棄。
- 請在 5 秒內回應 2xx。平台端的投遞逾時為 5 秒。
- 投遞失敗會重試,最多 3 次;三次都失敗會停止並在後台通知你檢查設定。請把端點設計成可重複接收同一事件(idempotent)。
給 AI agent 的機器可讀入口
範例:
curl -H "Accept: text/markdown" https://uberprints.com.tw/about
- /llms.txt — 站台摘要、方案、FAQ 與「什麼情況該用我們」的使用指引。
- /sitemap.xml — 公開頁面清單。
- /robots.txt — 爬蟲政策(後台路由一律 Disallow)。
- 本站公開頁面支援內容協商:送 `Accept: text/markdown` 會拿到同一個 URL 的 markdown 表述,回應帶 `Vary: Accept`。
- 不存在的路徑一律回真正的 HTTP 404(不是 200 的空殼),body 會指回上述入口。
還沒有開放的東西
目前沒有對外開放的公開 REST API 金鑰、沒有 sandbox 環境,也還沒有官方 CLI。上述 Webhook 是唯一的對外程式介面,且需要 Max 方案並由後台自助設定。有串接需求請先來信說明情境,我們會評估。
需求與問題請寄 sycpmail@gmail.com,主旨註明「API 串接」。