Skip to main content

認証

VoiceCheap APIは認証にAPIキーを使用します。すべてのAPIリクエストには、x-api-keyヘッダーにAPIキーを含める必要があります。

APIキーの取得

1

VoiceCheapにサインイン

app.voicecheap.aiにアクセスし、アカウントにサインインします。
2

APIページへ移動

app.voicecheap.ai/page-apiAPIページに移動します。
3

APIキーの生成

新しいキーを作成をクリックし、キーに名前を付けます。完全なAPIキーは一度しか表示されないため、すぐにコピーして安全な場所に保管してください。
重要:キーをすぐに保存してください完全なAPIキーは作成時に一度だけ表示されます。モーダルを閉じると、マスクされたバージョン(vc_abc...xyz)のみが表示されます。キーを紛失した場合は、削除して新しいキーを作成する必要があります。

APIキーの制限

  • アカウントごとに最大5つのAPIキーを作成できます
  • 各キーには、識別しやすい名前を付けることができます(例:「本番環境」、「開発環境」)
  • キーはAPIページからいつでも削除できます

APIキーの使用

すべてのリクエストで、x-api-keyヘッダーにAPIキーを含めてください:

要件

有料サブスクリプションが必要APIへのアクセスには、有効な有料サブスクリプションが必要です。無料アカウントではAPIを使用できません。有効なサブスクリプションなしでAPIを使用しようとすると、403 Forbiddenエラーが発生します。

APIキーのセキュリティ

秘密を保持する

APIキーをクライアント側のコード、公開リポジトリ、または一般にアクセス可能な場所に公開しないでください。

環境変数を使用する

APIキーは環境変数または安全なシークレットマネージャーに保存してください。

定期的にローテーションする

特に漏洩の疑いがある場合は、定期的にAPIキーをローテーションしてください。

使用状況を監視する

APIの使用状況を追跡し、不正アクセスを検知できるようにしてください。

エラーレスポンス

認証に失敗した場合、以下のいずれかのエラーが返されます:

エラーレスポンスの例