Skip to main content
POST
Log in
**沒有 API 金鑰。**4casters 目前還不發放 API 金鑰。使用你帳戶的使用者名稱和密碼登入,就像在網站上一樣,然後使用回傳的令牌。令牌如何在三套 API 中使用、以及如何處理它 30 天的有效期,見 認證概述。
要使用任何需認證的路由,你需要一個認證令牌。令牌透過登入獲取,有效期為 30 天,之後需要重新登入。

登入

POST /user/login

請求

string
必填
帳戶使用者名稱(或電子郵件)。
string
必填
帳戶密碼。

回應

令牌會同時作為 data.user.auth 以及簽名 auth Cookie(Set-Cookie)回傳。對於大多數伺服器端整合,你應捕獲 data.user.auth 並丟棄 Cookie。
全部欄位見 OpenAPI schema 中的 User。

錯誤回應

為請求授權

在後續每個請求中傳遞來自 data.user.auth 的令牌。按以下優先順序接受三種請求標頭 / 酬載格式:
Bearer 前綴是可選的 — 直接傳遞裸令牌也可以。
如果未提供令牌 — 或令牌未知 / 已過期 — 伺服器回應 401 InvalidCredentials。

令牌輪換

使用超過 30 天的令牌發起的已認證請求會自動輪換為新令牌。發生時,新令牌會在 X-Auth-Token 回應標頭中回傳(並作為更新後的簽名 auth Cookie)。舊令牌立即失效;觸發輪換的那次請求仍會成功,但之後任何使用舊值的請求都會回傳 401。長期執行的整合應監聽此回應標頭並持久化新值,或者乾脆在遇到任何 401 時重新登入。

登出

POST /user/logout 會使發起該呼叫所用的令牌失效。之後使用該令牌的請求回傳 401;同一帳戶持有的其他令牌不受影響。

雙重認證

雙重認證保護的是提款,而不是登入。無論帳戶的 2FA 設定如何,POST /user/login 都不會要求驗證碼。

主體

application/json
username
string
必填
password
string<password>
必填

回應

Login successful. The auth token is returned both as data.user.auth and as a signed auth cookie.

data
object