認証 - Supertone API Documentation

このドキュメントは英語の原文から自動翻訳されています。表現に不自然な箇所がある場合があります。正確な内容は英語の原文もあわせてご確認ください。

Supertone APIは、カスタムヘッダーで送信されるAPI Keyによってリクエストを認証します。Keyは開発者コンソールから発行され、アカウントに紐付けられます。

Keyを発行する

export SUPERTONE_API_KEY="Kp9mZ3xQ7v..."

1つのアカウントにつき最大3つのアクティブなAPI Keyを保有できます。Keyが流出した場合は、コンソールから廃棄して再発行してください。

すべての呼び出しで、x-sup-api-keyリクエストヘッダーにKeyを含めてください。

SDKはコンストラクタからKeyを読み込みます。環境変数と接続してください。

import os
from supertone import Supertone

client = Supertone(api_key=os.environ["SUPERTONE_API_KEY"])

import { Supertone } from "@supertone/supertone";

const client = new Supertone({ apiKey: process.env.SUPERTONE_API_KEY });

curl https://supertoneapi.com/v1/voices \
  -H "x-sup-api-key: $SUPERTONE_API_KEY"

ステータス	発生条件
`401 Unauthorized`	`x-sup-api-key`ヘッダーが欠落している、不正な形式である、またはアクティブなKeyと一致しません。
`403 Forbidden`	Keyは有効ですが、リソースへのアクセス権限がありません。例えば、別アカウントに属するクローンボイスを呼び出した場合などです。

完全なエラー一覧と推奨対応についてはエラー処理を参照してください。

クライアント側のコードにKeyを埋め込まないでください。 モバイルアプリ、シングルページアプリ、ブラウザ拡張機能などは、Keyを保持する自前のバックエンドを呼び出す形にしてください。
環境変数、シークレットマネージャー、またはキーボルトサービスを利用してください。Keyをgitにコミットしたり、ログに出力したりしないでください。
流出が疑われる場合は直ちにKeyをローテーションしてください。コンソールから廃棄し、再発行し、再デプロイします。
サービス単位でKeyを分けてください。 複数のアプリを運用している場合は、Keyを分けて発行することで、利用量を切り分けたり、個別に廃棄したりできます。