串接資訊

路徑：/merchant/api-docs  |  快捷鍵：9 → A  |  權限要求：merchantApiDocs

查看該商戶的 API 串接設定、互動式 API 文件，以及 API 的歷次版本異動紀錄。

串接配置

項目	說明
商戶代碼	API 串接所需的商戶識別碼（等寬字型，可複製）
API服務	該商戶的 API 服務是否啟用（綠色「已啟用」/ 紅色「未啟用」）
狀態	商戶帳號是否啟用（綠色「已啟用」/ 紅色「未啟用」）
API 金鑰	API 驗證用的 Secret（遮罩顯示，可切換顯示/隱藏）

API 金鑰安全性

• 預設以 •••• 遮罩顯示
• 點擊眼睛圖示可切換顯示／隱藏
• 只有在顯示狀態下才會出現複製按鈕

DANGER

API 金鑰是串接驗證的重要憑據，請妥善保管，切勿外洩。如需重新產生金鑰，請聯繫系統管理員（重新產生會使舊金鑰立即失效，串接需同步更新）。

API 文件

點擊 「開啟 API 文件」 按鈕，在新分頁開啟 Swagger 互動式文件，內含所有可用端點的說明、請求／回應格式、參數定義與範例，並可直接在頁面上測試。

付款人 Email 可設為選填（站點限定）

建單 API（POST /api/payment/create）的付款人 Email 預設是必填。 部分站點改為選填 —— 來源系統帶不出 Email 時仍可正常建單。

• 沒帶或帶空字串都放行；有帶值就照樣驗格式與長度，不能塞任意字串
• 付款人姓名與手機仍為必填（那兩項是配對入帳與客服聯絡的依據）
• 文件上的必填標記會跟著站點顯示，以你自己站點的 Swagger 為準

版本紀錄

頁面下方以 時間軸 呈現 API 的歷次版本，最新版本以主色圓點與主色標籤標示。

每一列顯示：

項目	說明
版本	v{版本號} 標籤
日期	該版本發布日期
異動統計	🟢 N 新增、🟡 N 修改、🔴 N 移除（無異動時不顯示）
查看詳情	有實質異動時才出現，點擊開啟差異彈窗

若版本數超過一頁，底部提供 「載入更多」。

差異彈窗

點擊「查看詳情」後，彈窗依類型分區列出該版本的異動：

區塊	說明
新增端點	這一版新增的 API 路徑
移除端點	這一版移除的 API 路徑
修改端點	逐筆列出「端點 / 欄位 / 修改前 / 修改後」

內部格式調整不會被當成異動

若比對結果只是 Swagger 產出的 JSON 欄位順序不同、並非實際的 API 變更，彈窗會顯示「本次更新為內部格式調整，API 功能無實質變更」。

版本更新會主動通知

API 文件更新時，系統會自動發送一封標題為 API 文件更新 v{版本} 的站內信給全部商戶，內含直接跳轉到本頁對應版本的連結。