跳至正文
TurnitPass
開發者中心API v1管理金鑰
瀏覽文件

開發者認證

使用 Bearer API 金鑰認證

開發者請求使用 TurnitPass 工作台產生的 API 金鑰。

REST API v1

認證說明

不要把 API 金鑰放进浏览器。

TurnitPass API 使用归属工作台的 Bearer 金鑰。金鑰只应出现在服务端代码中;建立、輪換、撤銷和查看用量仍在工作台完成。

金鑰護欄

如何安全保管访问凭证

仅限服务端

从后端路由、worker、任务或受保护的服务端操作发送金鑰。

只显示一次

立即复制生成的金鑰,并存入金鑰管理。

安全輪換

先部署新金鑰,再撤銷旧的生产金鑰。

归属帳戶

用量汇总到工作台字数餘額与帳單控制。

Bearer 请求

请求头约定

預設僅本人可見
request
Bearer
fetch('https://turnitpass.com/api/v1/humanize', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer tp_live_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ text: draft, language: 'en' })
})
認證失败
failed auth
401
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}
01在工作台生成
02存入金鑰库
03从服务端调用
04輪換或撤銷

API 金鑰

在每次請求中傳送 `Authorization: Bearer tp_live_...`。金鑰僅在建立時顯示一次,之後安全加密儲存,且隨時可在工作台撤銷。

Authorization header
Bearer
Authorization: Bearer tp_live_your_api_key
Content-Type: application/json

POST /api/v1/humanize
金鑰在建立时只显示一次,可在工作台撤銷,不影响 Google 登入帳戶。

管理金鑰

01

建立

在工作台生成带名称的金鑰,并立即复制。

02

撤銷

立即停用金鑰。已撤銷的金鑰无法用于新请求。

03

速率限制

每把金鑰可獨立限流,用量仍汇总到帳戶。

04

帳單

所有金鑰共享帳戶字数餘額和订阅限额。

归属工作台

金鑰生命週期

1

建立带名称的金鑰

用能說明环境或应用面的名称,例如生产后端、預發 worker 或内部 QA。

2

复制一次并放入金鑰库

TurnitPass 仅在建立时显示金鑰。放入部署平台、CI 金鑰库或本地 .env。

3

通过状态和帳單查看用量

所有金鑰共享帳戶字数餘額;金鑰名称便于定位正在使用的接入。

4

先輪換再撤銷

建立替换金鑰、完成部署并确认流量正常后,再在工作台撤銷旧金鑰。

環境設定

将 TurnitPass 金鑰作为仅服务端金鑰保存。以下示例使用通用名称,适用于 Next.js、Workers、后台任务或任意后端运行时。

.env
server only
TURNITPASS_API_KEY=tp_live_your_api_key
TURNITPASS_API_BASE_URL=https://turnitpass.com/api/v1
本地开发
.env.local 或本地金鑰管理使用非生产金鑰,配较小字数額度,并起清晰名称。
預發部署
預發金鑰将預發流量分开,避免测试任务意外消耗生产用量。
生产环境
仅服务端金鑰只从受信任的服务端代码读取金鑰,切勿传到浏览器。

安全建議

仅限服务端
切勿在浏览器代码中暴露金鑰从后端服务、任务或受保护的服务端路由使用金鑰。
环境变量
使用 TURNITPASS_API_KEY不要把线上金鑰写进源码或客户端包。
輪換金鑰
先建立替换金鑰再撤銷生产、預發与开发使用不同金鑰。
洩露处置
立即撤銷若金鑰洩露,从工作台建立新金鑰。

認證錯誤

缺少请求头
未提供 Authorization 请求头
格式錯誤
请求头未以 Bearer 开头
无效金鑰
金鑰不存在、已撤銷或格式錯誤
失败过多
反复認證失败可能被限流
401 response
JSON
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}

下一步

下一步,把它接到你的工作流程。繼續閱讀