ドキュメントを見る

Bearer キーを作成し、ローテーションする

キーはワークスペースで管理します。このページではライフサイクル、セキュリティモデル、本番連携のリクエスト形を説明します。

REST API v1

開発者向けプラットフォーム

概要

ワークスペースを開く

ワークスペースのキーを作成

ログインし、名前を付け、一度コピーして自分のシークレットストアに保管します。

認証ドキュメント

Bearer 認証を確認

ヘッダー形式、保管規則、失効、環境の分離を確認します。

ワークスペース

GET/api/v1/status

アカウント単位

ステータス確認

GET /api/v1/status

1curl https://turnitpass.com/api/v1/status \
2  -H "Authorization: Bearer tp_live_your_api_key"

説明

キー形式

キーは作成時に一度だけ表示され、ワークスペースからローテーションできます。

保管

平文は初回表示のあと再表示されません。

既定上限

本番、ステージング、ローカルのキーは分けてください。

キーのライフサイクル

連携ごとの小さな運用ループ

環境に名前を付ける

本番、ステージング、デモなど分かりやすい名前にすると利用ログが読みやすくなります。

一度だけコピーする

完全なトークンは作成時にだけ出ます。サーバー側のシークレットに置き、フロントには置かないでください。

先にステータスを確認

本文を送る前に GET /api/v1/status でキー、残高、上限を確認します。

無停止でローテーション

新しいキーを作り、展開し、トラフィックを確認してから古いキーを失効します。

セキュリティの詳細

キーシステムが保証すること

ヘッダー

Authorization: Bearer API keyすべての v1 ルートが同じ Bearer 形式を使います。

保管

保存時に保護平文トークンは初回表示のあと返されません。

失効

即時失効したキーは認証できません。アカウントと他のキーはそのまま使えます。

範囲

アカウント所有利用量、語数、請求、履歴はワークスペースのアカウントに帰属します。

実装上の注意。 作成と失効はログインが必要なためワークスペースに残します。公開ドキュメントは秘密を出さずに流れを説明します。

次に、ワークフローへ接続します。続きを読む