
- 登入
- 註冊

API 串接是讓不同系統依照約定格式交換資料或觸發動作。會員註冊、訂單成立、付款結果、發票開立與通知,都可能透過 API 或其他整合方式銜接。但真正的專案不只「把資料傳過去」,還要定義權限、錯誤、重試、版本與監測責任。
企業在詢價前,應先說清楚資料從哪裡來,要到哪裡,何時觸發,失敗怎麼辦,以及哪一套系統是最終主檔。這些答案比先指定程式語言更能決定 API 串接範圍。
請求逾時只代表呼叫方沒有收到回應,原請求可能已經執行,所以金流回寫要先查詢交易結果,再決定是否重試。下面用五種狀態整理該核對什麼,內容是通用整合設計示例,不是服務商實際列舉值。各家通知、查詢、簽章與冪等機制不同,要依官方文件及合約實現。
| 示例狀態或事件 | 應做的核對 | 避免的錯誤 |
|---|---|---|
| 建立訂單/付款處理中 | 保存唯一訂單、金額、幣別及請求識別 | 不能每次重試就新建一筆應收 |
| 請求逾時、結果未明 | 先按官方介面查交易,再決定是否重試 | 不直接再扣款,不把網路失敗當業務失敗 |
| 成功通知重送或亂序 | 驗證簽章、商店、訂單、金額及幣別;去重並檢查當前狀態 | HTTP 200 與瀏覽器導回不等於所有業務步驟成功 |
| 退款處理中/已退款 | 按原交易核對發起、服務商結果與交付端 | 按鈕按下不等於款已退到消費者 |
| 付款成功但發票失敗 | 保留付款狀態,另處理開票例外 | 不能因為發票錯誤就抹掉成功交易 |
每個動作留時間、介面版本、請求識別、結果及負責人;跨系統部分完成時列可恢復步驟。簽章與身分驗證可參考OWASP API Security風險方向,具體支付與發票能力仍逐家確認。資料主檔與驗收案例可接續需求規格樣本。
API 串接要約定的不只是資料格式,還包含權限、錯誤、版本與營運責任。以下五項只要有一項沒寫清楚,上線後就可能變成沒有人負責的問題。
API 是 Application Programming Interface,中文常譯為應用程式介面。白話來說,它像一個有菜單與規則的服務窗口:呼叫方依指定格式提出要求,提供方驗證權限,執行動作,再回傳結果或錯誤。
「串接」是把兩套原本各自運作的系統接起來,讓一邊發生的事件自動帶動另一邊的資料或動作,不必靠人工重複輸入。中文也常稱為 API 介接或 API 整合,在企業專案裡指的多半是同一類工作。
比喻只能協助入門。實際 API 還涉及傳輸協定、認證、資料格式、額度、版本與安全控制。沒有官方文件、測試環境與憑證,就不能只看到「有 API」三個字便承諾串接。
API 串接的基本動作是一來一回:呼叫方對提供方的某個端點送出請求,提供方驗證身分後處理,再用回應告訴你結果。看懂下面六個名詞,會比較容易和工程團隊或廠商核對串接範圍。
| 名詞 | 白話解釋 | 專案上要確認 |
|---|---|---|
| 端點(Endpoint) | 提供方開放的網址,一個端點對應一種資料或動作 | 文件列出哪些端點,目前的方案是否有權使用 |
| 請求(Request) | 呼叫方送出的要求,包含方法、參數與資料 | 必填欄位、格式與大小限制 |
| HTTP 方法 | 說明這次請求要做什麼,例如 GET 用來讀取資料,POST 用來送出資料並可能改變伺服器上的狀態 | 同一個請求重送時,會不會重複建立資料 |
| 回應(Response)與狀態碼 | 提供方回傳的結果;狀態碼 200 到 299 表示成功,400 到 499 是請求端的錯誤,500 到 599 是伺服器端的錯誤 | 每個錯誤碼的意義,以及收到成功回應後還要核對哪些業務結果 |
| JSON | 一種資料交換格式,用欄位名稱與值描述資料 | 欄位名稱、型別、時區與代碼如何對應 |
| 認證與授權 | 用 API Key、OAuth 權杖或簽章,證明呼叫方是誰以及能做什麼 | 憑證由誰保管,如何輪替與撤銷 |
HTTP 方法與狀態碼的定義可查 MDN 的HTTP 請求方法與HTTP 回應狀態碼說明(2026 年 10 月查核)。各家 API 實際使用哪些方法、欄位與錯誤碼,仍以服務商的官方文件為準。
四種方式的差別在由誰主動發起,資料需要多即時,以及出錯時怎麼補救:API 由呼叫方主動請求,Webhook 由來源系統在事件發生時通知,檔案匯入適合低頻的批次交換,資料庫直連的耦合與安全風險較高,較適合受控的內部環境。
| 方式 | 運作 | 較適合情境 | 主要風險 |
|---|---|---|---|
| API | 一方主動提出請求並取得回應 | 查詢、建立、更新與即時動作 | 權限、額度、逾時與版本 |
| Webhook | 事件發生時,由來源系統主動通知 | 付款完成、訂單更新、狀態變更 | 重複通知、遺漏、驗證與重試 |
| 檔案匯入 | 以 CSV 等檔案批次交換 | 低頻、大量或人工審閱流程 | 版本、欄位、重複與延遲 |
| 資料庫直連 | 直接存取底層資料庫 | 受控內部環境與特定架構 | 耦合、權限、安全與升級影響 |
同一流程可以混合使用。例如,Webhook 通知付款完成,系統再用 API 查詢完整交易資料;夜間則用檔案對帳。選擇依一致性、延遲、可靠性與供應商能力決定。
會員、訂單、金流、發票與通知是五類常見的串接情境,每一類都要先決定哪一端是主檔,以及失敗時由誰補救。
付款與發票涉及敏感資料與正式交易結果,必須以服務商官方文件、適用規範與專業審查為準。文章只說明整合責任,不提供可直接使用的憑證或交易程式碼。
要在正式環境收款,商家得先向支付服務商申請並通過審核,核准結果、費率與可用的付款方式由服務商決定。申請前的準備可看《金流申請完整指南》,核准後的啟用、測試、退款與對帳則見《金流申請通過後怎麼開始收款》。若只需要收款連結或 QR Code,不一定要自己開發金流串接,可先用立即付建立商店,再評估是否還需要客製系統。
串接對象是 LINE 官方帳號、LINE Login 或 CRM 時,各有不同的介面與驗收重點,可接著看《LINE API 串接指南》與《CRM 系統怎麼選》。要讓 AI 助理透過 API 查詢或建立資料,權限與停止條件另見《AI 系統整合完整指南》。
詢價或開工前,先回答流程、主檔、欄位、權限、錯誤與非功能六類問題,並各自留下一份可以檢查的輸出。
| 項目 | 要回答的問題 | 輸出 |
|---|---|---|
| 流程 | 什麼事件觸發,誰使用結果 | 資料流與責任圖 |
| 主檔 | 會員、訂單、付款或發票以哪端為準 | 資料擁有權矩陣 |
| 欄位 | 名稱、型別、代碼、時區如何對應 | 欄位映射表 |
| 權限 | 使用何種認證,憑證由誰管理 | 權限與金鑰生命週期 |
| 錯誤 | 逾時、重複、部分失敗怎麼處理 | 錯誤、重試與人工補救 |
| 非功能 | 額度、延遲、可用性與監測要求 | 可測試服務條件 |
沒有資料主檔與錯誤責任,串接後很容易出現兩邊數字不同,卻沒有人知道應修哪一端。這類問題應在開發前寫入系統開發需求規格書。
API 串接可以分七步進行:先定義事件與主檔,取得官方文件與測試環境,完成設計與高風險驗證,再進入開發與測試,準備好切換與回復,上線後持續監測。
詳細專案階段可回到《系統開發流程完整指南》;如果尚未確定該串接或客製,先看《客製化系統開發指南》比較解法。第 5 步的例外案例怎麼寫成可重現的驗收項目,可參考《系統開發驗收清單》。
搜尋「API 串接費用」時,常被混在一起的是第三方 API 用量費與系統整合開發費。前者是供應商依方案、呼叫量、資料量或功能收取的服務費;後者是企業為需求盤點、欄位映射、權限、程式開發、測試與維運支付的工作成本。即使 API 本身免費,串接仍可能需要開發與維護。
| 費用 | 由誰收取 | 常見構成 | 如何估算 |
|---|---|---|---|
| 第三方 API 用量費 | API 服務供應商 | 方案與請求量;Token 與資料量;超額或附加功能 | 用真實用量情境查官方定價 |
| 串接開發費 | 規劃或開發團隊 | 規格與資料映射;權限與開發;測試、錯誤處理與監測 | 依範圍、介面與驗收條件估價 |
| 持續維運費 | 供應商與維運團隊 | 監測與告警;憑證與版本變更;故障和資料修復 | 依服務重要性與支援邊界估算 |
至少準備 API 官方文件、帳號與環境狀態、預估請求量、來源與目的欄位、同步時機、權限規則、失敗處理、驗收案例與上線後責任。若第三方尚未提供正式文件,報價應明確標註假設與變更條件,不宜把猜測寫成固定總價。串接若是整個系統專案的一部分,整案的報價構成與估價方式見《系統開發費用怎麼算》。
API 可能調整版本與欄位,也可能改變驗證方式與用量限制,或改變服務終止時程。正式系統應指定誰接收公告,誰評估影響,如何在測試環境驗證,以及失敗時如何回復。這些工作不一定每天發生,卻是串接能否長期運作的必要成本。
驗收 API 串接要分三層:HTTP 回應是否符合介面規格,業務資料是否正確,以及後續流程是否完成。HTTP 202 只表示已接受處理,並不表示工作已完成;其他成功回應也要依該介面的約定,繼續核對交易或資料結果。這項區分可對照 HTTP Semantics 的 202 定義(2026 年 11 月 3 日核對)。
下面是可改寫成驗收單的通用示例。測試資料、判定依據與實際狀態名稱,須在開發前依雙方文件確認,不代表即站力已完成任何特定客戶或供應商串接。
| 測試情境 | 測試做法 | 完成證據 |
|---|---|---|
| 正常建立 | 用一筆已知測試資料建立訂單,再查回結果 | 兩端的訂單識別、金額、幣別及對應主檔一致 |
| 回應逾時 | 在測試環境模擬送出後未收到回應,再依官方查詢或冪等規則處理 | 結果可查,且沒有因補送而多建一筆訂單或多扣一次款 |
| 重複或亂序通知 | 重送同一事件,再送較舊狀態;只使用供應商允許的測試方式 | 事件可去重,既有最終狀態不被較舊通知覆蓋,並留處理紀錄 |
| 部分流程失敗 | 讓付款後的發票或通知步驟失敗,再按補救程序處理 | 付款結果仍保留,失敗步驟可辨識、可補救,並有負責窗口 |
通知端的簽章、重送與重複事件,另見 Webhook 串接與失敗處理。要把上表轉成正式測試案例,可用 系統開發驗收清單補上測試輸入、預期結果、實際證據及驗收人。
API 金鑰、Token 與使用者資料都需要最小權限、保存、輪替與撤銷。錯誤訊息與紀錄也可能含敏感資訊,不應直接公開。OWASP API Security Project提供 API 風險與實務參考,實際控制仍要依架構與資料決定。
開始整合前,先整理需求規格書、串接系統的官方文件與驗收清單,並指定資料負責人和異常處理窗口。即站力會依實際流程評估可行性,再確認哪些功能可直接使用,哪些需要開發。服務範圍與合作流程可先看即站力系統開發服務頁。
不一定。還要確認方案權限、功能範圍、資料欄位、額度、測試環境、認證、錯誤與使用條款。
API 常由呼叫方主動請求,Webhook 則由來源系統在事件發生時通知。實務上常搭配使用。
取決於文件品質、權限、欄位、錯誤、測試與供應商配合。未取得官方文件與測試環境前,不宜承諾固定時程。
敏感憑證通常不應暴露在可被使用者取得的前端程式。實際認證架構要依服務商官方安全建議設計。
不會自然一致。要事先設計重試、冪等、對帳、人工補救與告警,並定義哪一端資料為準。
訂閱官方公告,保存使用版本與測試,評估相容性並安排切換。合約與維運範圍也要明確指定追蹤責任。