驗證方式
呼叫任務 API(/api/tasks/*)時,每個請求都要在 header 帶上 API 金鑰:
X-Api-Key: sk-live-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
沒帶金鑰會回傳 401 Unauthorized:
{ "message": "API key required." }
金鑰類型
| 類型 | 開頭 | 說明 |
|---|---|---|
付費金鑰(paid) |
sk-live- |
使用帳號的付費積分,沒有使用期限 |
試用金鑰(trial) |
sk-test- |
使用指定的一筆試用額度,額度到期後就無法再使用 |
取得方式
金鑰在後台的API 金鑰頁面管理,可以建立、重新發放或撤銷。
付費金鑰:儲值成功過一次之後,才能在「付費金鑰」分頁點擊「建立付費金鑰」。剩餘積分可以用金鑰查詢,詳見〈查詢剩餘積分〉。
試用金鑰:在「試用金鑰」分頁選一筆還沒到期、還有剩餘的試用額度,再點擊「建立試用金鑰」。每筆試用額度同時只能有一把使用中的金鑰。額度到期後,金鑰會跟著失效,也不能再建立或重新發放。
金鑰建立後會立即顯示完整內容,之後也可以在列表中點擊「顯示」再次查看。
請求頻率限制
| 類型 | 每分鐘請求次數 | 每天請求次數 |
|---|---|---|
| 付費金鑰 | 300 | 100,000 |
| 試用金鑰 | 20 | 1,000 |