API 文件
了解如何整合 Mercozy API 來管理商品、訂單、庫存等。
快速開始
1
取得 API 金鑰
以管理員身份登入並前往 設定 > 整合 > API 金鑰 以產生新金鑰。僅管理員有權限。
2
在請求中包含金鑰
在所有 API 請求中加入 X-API-Key 標頭。
3
開始發送請求
使用任意 HTTP 用戶端與 Mercozy API 端點互動。
身份驗證
所有 API 請求都需要透過 X-API-Key 標頭發送有效的 API 金鑰。
bash
curl https://api.mercozy.com/api/v1/external/products \
-H "X-API-Key: mk_live_your_key_here"API 金鑰綁定到您的租戶。請妥善保管，切勿在客戶端程式碼中暴露。
基礎 URL
https://api.mercozy.com/api/v1/external速率限制
API 速率限制取決於您的訂閱方案。
| 方案 | 速率限制 | API 存取 |
|---|---|---|
| Free / Standard | 無 API 存取 | No |
| Pro | 300 請求/分鐘 | Yes |
| Business | 1,000 請求/分鐘 | Yes |
回應格式
所有回應均以 JSON 格式傳回。
成功回應
json
{
"data": [
{
"id": "prod_abc123",
"name": "Premium Widget",
"price": 2999,
"currency": "USD"
}
],
"meta": {
"total": 42,
"page": 1,
"limit": 20
}
}錯誤回應
json
{
"statusCode": 401,
"message": "Invalid API key",
"error": "Unauthorized"
}錯誤碼
| 錯誤碼 | 狀態碼 | 描述 |
|---|---|---|
VALIDATION_ERROR | 400 | 請求參數無效 |
UNAUTHORIZED | 401 | API 金鑰無效或缺失 |
FORBIDDEN | 403 | 權限不足 |
NOT_FOUND | 404 | 找不到資源 |
CONFLICT | 409 | 資源已存在或發生衝突 |
RATE_LIMITED | 429 | 請求過於頻繁 |
INTERNAL_ERROR | 500 | 伺服器內部錯誤 |