Authentication
Platform API 使用 private key 做為主要驗證方式。private key 不會公開發放,請聯繫客服申請。
警告
Private key 屬於伺服器端憑證。請不要放在瀏覽器端程式碼、公開 repository、客服截圖或可被外部讀取的 log 中。
Header
x-api-key: <private_key>
Example
curl "https://api.guo-guo.com/platform/organization" \
-H "x-api-key: <private_key>"
Key Handling
提示
建議由後端服務保存 private key,並由後端呼叫 Platform API。若 private key 外洩,請立即聯繫客服停用並重新申請。
Common Authentication Errors
| HTTP Status | Code | Meaning | How to Fix |
|---|---|---|---|
401 | token_validation_failed | request 未帶入有效的 x-api-key,或 key 已失效。 | 確認 header 名稱與 key 值,必要時聯繫客服重新申請。 |