Find Helper

API 開發者文件

找幫手平台 API 使用說明與範例

快速開始
使用找幫手 API 前，您需要先建立 API 金鑰

步驟 1：建立 API 金鑰

前往 API 金鑰管理頁面 建立新的 API 金鑰。 建立後，您會獲得一組 API Key 和 API Secret，請妥善保管。

步驟 2：使用 API 金鑰

在每次 API 請求中，您需要在 HTTP Header 中包含 API Key 和 API Secret：

X-API-Key: your_api_key_here
X-API-Secret: your_api_secret_here
API 端點
找幫手平台提供以下 API 端點
GET/api/jobs

取得工作列表。支援篩選參數：city、jobType、status

範例請求（curl）：

curl -X GET "https://api.find-helper.com/api/jobs?city=台北市" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

範例請求（JavaScript）：

fetch('https://api.find-helper.com/api/jobs?city=台北市', {
  headers: {
    'X-API-Key': 'your_api_key',
    'X-API-Secret': 'your_api_secret'
  }
})
  .then(res => res.json())
  .then(data => console.log(data));

範例請求（Python）：

import requests

headers = {
    'X-API-Key': 'your_api_key',
    'X-API-Secret': 'your_api_secret'
}

response = requests.get(
    'https://api.find-helper.com/api/jobs',
    headers=headers,
    params={'city': '台北市'}
)

print(response.json())
GET/api/jobs/:id

取得特定工作的詳細資訊

範例請求（curl）：

curl -X GET "https://api.find-helper.com/api/jobs/123" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"
POST/api/jobs

建立新的工作訂單

範例請求（JavaScript）：

fetch('https://api.find-helper.com/api/jobs', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': 'your_api_key',
    'X-API-Secret': 'your_api_secret'
  },
  body: JSON.stringify({
    title: '居家清潔',
    jobType: 'general',
    city: '台北市',
    address: '台北市信義區信義路五段7號',
    estimatedAmount: 3000
  })
})
  .then(res => res.json())
  .then(data => console.log(data));
回應格式
所有 API 回應都使用 JSON 格式

成功回應範例：

{
  "success": true,
  "data": {
    "id": 123,
    "title": "居家清潔",
    "jobType": "general",
    "city": "台北市",
    "status": "published",
    "createdAt": "2026-02-07T08:00:00.000Z"
  }
}

錯誤回應範例：

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API credentials"
  }
}
錯誤代碼
常見的 API 錯誤代碼與說明
401

UNAUTHORIZED

API 金鑰無效或已過期

403

FORBIDDEN

沒有權限存取此資源

404

NOT_FOUND

找不到指定的資源

429

TOO_MANY_REQUESTS

請求次數超過限制，請稍後再試

500

INTERNAL_SERVER_ERROR

伺服器內部錯誤

使用限制
API 使用限制與配額
•

每個 API 金鑰每分鐘最多 60 次請求

•

每個 API 金鑰每天最多 10,000 次請求

•

單次請求的回應大小不超過 10MB

•

API 金鑰需定期更新以確保安全性

準備好開始了嗎？

立即建立您的 API 金鑰