跳至正文
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"
}

下一步

下一步,把它接到你的工作流。继续阅读