金鑰與驗證
每個請求都在 Authorization 標頭帶 API 串接的金鑰。金鑰最多同時兩把,換新時不用停機。串接可以限定來源 IP。
每個請求都要帶 API 串接的金鑰。金鑰屬於一個串接,串接屬於一位 agent。這個串接能做什麼,由設定的人在主控台決定。
帶金鑰
在 Authorization 標頭寫 Bearer 加上金鑰:
Authorization: Bearer dak_8Yf2…
- 金鑰放在你們伺服器上,不要放進網頁或 App。
- 金鑰只在建立時顯示一次。我們只存雜湊,拿不回明文。
換新金鑰,不停機
- 請設定的人在串接上按 產生新金鑰。這時新舊兩把都能用。
- 把你們系統換成新的金鑰。
- 請設定的人撤銷舊的那把。撤銷之後,用它的呼叫會馬上失敗。
來源 IP
串接可以設 IP 白名單。設了之後,不在名單上的位址會收到 403 ip_not_allowed。名單可以寫單一位址,也可以寫網段,例如 203.0.113.0/24。
會被擋下的情況
| 回應 | 原因 |
|---|---|
401 unauthorized |
沒帶金鑰、金鑰寫錯,或已經撤銷 |
403 disabled |
串接關掉了 |
403 plan |
團隊的方案沒有 API |
403 ip_not_allowed |
來源 IP 不在白名單上 |
相關頁
本頁對應 v0.168.0