開放平台API狀態碼說明文件
文件說明
本文件定義了開放平台API介面回傳的狀態碼規範，用於明確介面呼叫結果、錯誤類型及原因，便於開發者快速定位和解決問題。所有API介面均遵循此狀態碼規則回傳結果。
狀態碼分類規則
| 狀態碼段 | 分類說明 |
|---|---|
| 200 | 成功（介面呼叫正常完成） |
| 1xxxx | 通用錯誤（非分類性異常） |
| 2xxxx | 驗證授權相關錯誤 |
| 4xxxx | 請求/參數驗證相關錯誤 |
| 5xxxx | 介面相關錯誤 |
| 6xxxx | 限流相關錯誤 |
| 7xxxx | 業務逻輯相關錯誤 |
狀態碼詳情
1. 成功狀態碼
| 狀態碼 | 列舉識別 | 說明 |
|---|---|---|
| 200 | SUCCESS | 介面呼叫成功 |
2. 通用錯誤（1xxxx）
| 狀態碼 | 列舉識別 | 說明 |
|---|---|---|
| 10000 | UNKNOWN_ERROR | 未知錯誤，請聯絡技術支援 |
3. 驗證授權相關錯誤（2xxxx）
| 狀態碼 | 列舉識別 | 說明 |
|---|---|---|
| 20001 | API_KEY_MISSING | API金鑰缺失（請求中未携带API Key參數） |
| 20002 | API_KEY_INVALID | 無效的API金鑰（已禁用、過期或未審核透過） |
| 20010 | TIMESTAMP_MISSING | 時間戳參數缺失（請求中未携带timestamp參數） |
| 20011 | TIMESTAMP_FORMAT_ERROR | 時間戳格式錯誤（必须為10位或13位數字） |
| 20012 | TIMESTAMP_EXPIRED | 時間戳已過期（請求逾時，需重新產生時間戳呼叫） |
| 20020 | SIGNATURE_MISSING | 簽章參數缺失（請求中未携带signature參數） |
| 20021 | SIGNATURE_VERIFY_FAILED | 簽章驗證失敗（簽章產生規則錯誤或參數被篡改） |
4. 請求/參數驗證相關錯誤（4xxxx）
| 狀態碼 | 列舉識別 | 說明 |
|---|---|---|
| 400 | INVALID_REQUEST | 請求體無法解析（需要檢查請求參數的傳遞方式是否符合文件要求） |
| 404 | NOT_FOUND | 介面路徑不存在（需要檢查請求的路徑是否正確） |
| 405 | REQUEST_METHOD_NOT_ALLOWED | 請求方法不允許（需要檢查請求的方法是否符合文件要求） |
| 40001 | REQUIRED_PARAMS_EMPTY | 必填參數缺失（介面要求的必傳參數未提交） |
| 40002 | REQUIRED_PARAMS_ILLEGAL | 請求參數不合法（參數格式/取值範圍不符合要求） |
5. 介面相關錯誤（5xxxx）
| 狀態碼 | 列舉識別 | 說明 |
|---|---|---|
| 50001 | INTERFACE_NOT_FOUND | API介面不存在（請求路徑錯誤） |
6. 限流相關錯誤（6xxxx）
| 狀態碼 | 列舉識別 | 說明 |
|---|---|---|
| 60001 | INTERFACE_RATE_LIMIT | 介面呼叫頻率超限，請稍後重試 |
7. 業務逻輯相關錯誤（7xxxx）
| 狀態碼 | 列舉識別 | 說明 |
|---|---|---|
| 70001 | NOT_ENOUGH_CREDIT | 帳戶餘額不足，請充值 |