錯誤處理

我們的 API 使用標準 HTTP 回應碼來表示要求的成功或失敗。以下是你可能遇到的常見錯誤碼及其處理方法。

HTTP 狀態碼

200 OK

要求成功。

400 Bad Request

要求無效或無法處理。

401 Unauthorized

驗證失敗或未提供。

403 Forbidden

要求已被理解，但已遭拒絕或不允許存取。

404 Not Found

找不到要求的資源。

429 Too Many Requests

你已超出速率限制。

500 Internal Server Error

我們這邊出現了問題。

錯誤回應格式

所有錯誤回應均遵循以下格式：

{
  "error": "error_code",
  "message": "Human-readable error message",
  "details": {}
}

常見錯誤碼

invalid_api_key: 提供的 API 金鑰無效。

missing_api_key: 未提供 API 金鑰。

invalid_ip: 提供的 IP 位址無效。

invalid_domain: 提供的網域無效。

rate_limit_exceeded: 你已超出速率限制。

quota_exceeded: 你已超出每月配額。

server_error: 發生了內部伺服器錯誤。

錯誤處理最佳實務

檢查狀態碼：在處理回應前，請務必先檢查 HTTP 狀態碼。

處理速率限制：針對 429 錯誤實作適當的退避及重試邏輯。

記錄錯誤：記錄詳細的錯誤資訊以便偵錯。

優雅降級：在 API 無法使用時準備好後備機制。