API 金鑰與身分驗證
建立、使用及撤銷帳戶金鑰。所有翻譯請求與結果下載都需要驗證。
建立金鑰
前往 開發者頁面,為金鑰取一個容易辨識的名稱,例如「我的網站」。每個帳戶最多保留 5 組有效金鑰。
完整金鑰只會顯示一次。請立即存進伺服器的環境變數或密鑰管理工具。遺失後無法取回,請撤銷並建立新金鑰。
建立金鑰時,帳戶須有可用的 Plus 點數(訂閱或購買點數),建立本身不扣點。每日免費的 Basic 點數不計入這項資格;即使訂閱仍有效,若已沒有可用的 Plus 點數,也無法建立新金鑰。可前往 帳務與儲值 查看帳戶方案與點數。
點數用完後,既有金鑰仍有效,也可以查詢或下載尚未過期的翻譯結果、查看與撤銷金鑰。送出新的翻譯時,仍須有足夠的 Plus 點數;補充 Plus 點數後即可再建立新金鑰。
放在 Authorization 標頭
以下為 Bash 與 curl 範例。先在你自己的環境設定 EZTRANSLATE_API_KEY,再執行請求:
curl "https://eztranslate.com.tw/api/v1/hokkien/translations/$JOB_ID" \
-H "Authorization: Bearer $EZTRANSLATE_API_KEY"
每次請求都需要這個標頭,包括狀態查詢、語音及圖片下載。網站登入狀態不能代替 API 金鑰;API 金鑰也不能登入帳戶或管理帳務。
不要把金鑰放在網址、前端 JavaScript、公開程式碼、分析事件或錯誤記錄中。瀏覽器應呼叫你自己的伺服器,再由伺服器呼叫 EzTranslate。
更換金鑰
- 建立新金鑰。
- 更新你的伺服器設定,確認新金鑰可正常查詢。
- 回到開發者頁面,撤銷舊金鑰。
撤銷後,舊金鑰的新請求會被拒絕。已接受的翻譯仍會完成與計費;同帳戶的其他有效金鑰可查詢及下載既有 API 工作。
金鑰名稱只用來辨識用途。「Development」與「Production」都會使用帳戶中的 Plus 點數,並不是獨立測試環境。
無法驗證時
401 invalid_api_key 表示標頭遺漏、格式錯誤、金鑰已撤銷,或所屬帳戶已不存在。修正金鑰後再重試;不要反覆重送失效的金鑰。
更新於