API 文檔

好事道提供完整的 RESTful API，讓開發者能夠整合我們的服務到自己的應用程式中。

開始使用

取得 API 金鑰

登入您的帳號後，前往「個人設定」→「API 管理」即可申請 API 金鑰。每個帳號最多可申請 5 組金鑰。

基礎 URL

驗證方式

所有 API 請求都需要在 Header 中包含您的 API 金鑰：

主要端點

用戶相關

• GET /user/profile - 取得用戶資料
• PUT /user/profile - 更新用戶資料
• GET /user/points - 查詢積分餘額

捐款專案

• GET /projects - 取得專案列表
• GET /projects/:id - 取得專案詳情
• POST /donations - 建立捐款
• GET /donations/history - 查詢捐款記錄

志工活動

• GET /activities - 取得活動列表
• GET /activities/:id - 取得活動詳情
• POST /activities/:id/register - 報名活動
• GET /activities/my-registrations - 查詢報名記錄

錯誤處理

API 使用標準的 HTTP 狀態碼表示請求結果：

• 200 OK - 請求成功
• 201 Created - 資源建立成功
• 400 Bad Request - 請求參數錯誤
• 401 Unauthorized - 未授權
• 404 Not Found - 資源不存在
• 429 Too Many Requests - 請求頻率過高
• 500 Internal Server Error - 伺服器錯誤

速率限制

為確保服務品質，API 有以下速率限制：

• 每分鐘最多 60 次請求
• 每小時最多 1,000 次請求
• 每日最多 10,000 次請求

SDK 與範例

我們提供多種程式語言的 SDK：

• JavaScript/TypeScript
• Python
• Java
• PHP

詳細的使用範例和 SDK 文檔即將推出。