跳至主要內容
SDK 與 API 產品情境示意
所有案例

設計提案

SDK 與 API

讓不同產品用同一個介面取得會員資料

設計範圍
API 欄位、SDK 程式套件、錯誤處理與版本相容

情境

不同產品各自處理登入與資料欄位,錯誤回應也不一致,每接一個新產品就要重做一次。

使用對象
接入會員服務的產品開發團隊

方案

先定義 API 的會員欄位與錯誤格式,再用 SDK 處理授權與重試,供各產品讀取會員資料。

查閱 API 欄位、呼叫範例與錯誤碼

請求、回應與錯誤處理放在同一個工作台,讓接入者知道如何呼叫、怎麼判讀,以及失敗後如何處理。圖中為 API 設計範例,不能直接串接。

查看流程與架構設計稿
API 設計範例,非可直接串接的正式 API。取得測試授權後,以一致的介面讀取示例會員。
API 設計範例,非可直接串接的正式 API。SDK 片段以 TypeScript 為例,實際語言依專案決定。
API 設計範例,非可直接串接的正式 API。授權過期、欄位不符與服務暫時不可用,各有固定的狀態碼與處理方式。

規劃項目

API 欄位定義、SDK 程式套件、錯誤處理、版本相容與使用文件。程式語言與授權方式依專案決定。

預計測試

測試資料欄位、授權過期、錯誤回應與新舊版本相容性。

授權過期
回傳固定的錯誤代碼,SDK 提示重新授權
欄位缺漏或格式錯誤
以一致的錯誤格式指出是哪個欄位
舊版 SDK 呼叫新版 API
相容期內維持原本行為,並提示升級
暫時性錯誤
只重試可安全重送的請求,且有次數上限

以上是建議的驗證條件,不是已通過的測試。

其他案例

有 App、網站開發或系統串接需求?

告訴我們想做的功能或遇到的問題,不必先準備需求書

討論需求