ドキュメントを見る
APIキーによる認証
開発者向けリクエストには、TurnitPassのワークスペースで生成されたAPIキーを使用します。
Auth console
API キーをブラウザに置かない。
TurnitPass API はワークスペース所有の Bearer キーを使います。キーはサーバー専用コードに置き、作成、ローテーション、失効、使用量確認はダッシュボードで行います。
キーの守るべき点
アクセスを安全に保つ
サーバーのみ
バックエンド、worker、ジョブ、保護されたサーバーアクションから送ります。
一度だけ表示
発行直後にコピーし、シークレット管理に保存します。
安全に入れ替える
本番の旧キーを失効する前に、新しいキーをデプロイします。
アカウント単位
使用量はワークスペースの語数残高と請求に集約されます。
Bearer リクエスト
ヘッダー契約
request
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
{
"error": "Invalid or revoked API key.",
"code": "invalid_api_key"
}
01ワークスペースで発行
02シークレットに保存
03サーバーから呼ぶ
04入れ替えまたは失効
API キー
各リクエストにAPIキーを含めて送信します。キーは作成時に一度だけ表示され、ワークスペースからいつでも無効化できます。
Authorization header
Authorization: Bearer tp_live_your_api_key
Content-Type: application/json
POST /api/v1/humanize
キーは作成時に一度だけ表示され、Google ログインを変えずにワークスペースから失効できます。
Managing keys
01
作成
名前付きキーを発行し、すぐにコピーします。
02
失効
すぐに無効化します。失効したキーは新しいリクエストに使えません。
03
レート制限
キーごとに独立して制限でき、使用量はアカウントに集約されます。
04
請求
すべてのキーがアカウントの語数残高とプラン上限を共有します。
ワークスペース所有
Key lifecycle
名前付きキーを作る
Production backend、Staging worker、Internal QA など、用途が分かる名前にします。
一度だけコピーして保管する
作成時のみ表示されます。デプロイ先、CI、または .env に保存します。
status と請求で使用量を見る
語数残高は共有されます。キー名でどの連携が動いているかを判別できます。
失効の前に入れ替える
新しいキーを作り、デプロイし、通信を確認してから旧キーを失効します。
Environment setup
TurnitPass キーはサーバー専用シークレットとして保存します。以下は Next.js、Workers、ジョブ、任意のバックエンドに使える汎用名です。
.env
TURNITPASS_API_KEY=tp_live_your_api_key
TURNITPASS_API_BASE_URL=https://turnitpass.com/api/v1
Security best practices
Authentication errors
401 response
{
"error": "Invalid or revoked API key.",
"code": "invalid_api_key"
}
Next steps
次に、ワークフローへ接続します。続きを読む