瀏覽文件

使用 Bearer API 金鑰驗證

每次請求都在 Authorization header 中以 Bearer 方式傳送 API 金鑰。

請求標頭

Authorization

Bearer

1Authorization: Bearer tp_live_your_api_key
2Content-Type: application/json

請求

fetch

1await fetch('https://turnitpass.com/api/v1/humanize', {
2  method: 'POST',
3  headers: {
4    Authorization: `Bearer ${process.env.TURNITPASS_API_KEY}`,
5    'Content-Type': 'application/json'
6  },
7  body: JSON.stringify({ text: draft, language: 'zh-Hant' })
8});

管理金鑰

建立

在工作台為金鑰命名。每個帳號最多 5 把有效金鑰。

撤銷

撤銷的金鑰會立即失效，其他金鑰不受影響。

環境設定

.env

server

1TURNITPASS_API_KEY=tp_live_your_api_key
2TURNITPASS_API_BASE_URL=https://turnitpass.com/api/v1

本機開發

.env.local 或本機密鑰管理工具使用另一把金鑰，並清楚命名。

預覽部署

預備環境金鑰測試流量不要使用正式環境金鑰。

正式環境

僅後端可讀的密鑰只在伺服器端程式碼中讀取金鑰。

安全最佳實務

僅限伺服器端

不要在瀏覽器程式碼中暴露金鑰在後端服務、排程任務或伺服器路由中使用金鑰。

環境變數

使用 TURNITPASS_API_KEY不要把正式金鑰提交到版本控制。

輪替金鑰

先建立替代金鑰，再撤銷舊金鑰部署新金鑰後再撤銷舊金鑰。

金鑰外洩

立即撤銷然後在工作台建立新金鑰。

驗證錯誤

missing_api_key

未傳送 Authorization header。

invalid_api_key

header 格式錯誤，或金鑰不存在、已撤銷。

回應

401

1{
2  "error": "invalid_api_key",
3  "code": "invalid_api_key",
4  "message": "Invalid or revoked API key."
5}