ワンタイム APPKEY 発行
ワンタイム APPKEY 発行するためのエンドポイントを提供しています。マイページに記載されたサービスIDとサービスパスワードからワンタイム APPKEY を発行できます。
- APPKEY は、アプリケーションが AmiVoice API 音声認識サービスを利用するためのサービス認証キー文字列です。
- ワンタイム APPKEY は、マイページに記載された[APPKEY]と同様の機能を持つサービス認証キー文字列ですが、発行日時と有効時間にもとづいた有効期限日時が設定されている点が異なります。
エンドポイント
POST https://acp-api.amivoice.com/issue_service_authorization
リクエスト
リクエストパラメータ
パラメータ名 | 必須 | 説明 |
|---|---|---|
| sid | ● | マイページの接続情報に表示される サービス ID を指定します |
| spw | ● | マイページの接続情報に表示される サービスパスワード を指定します。 |
| epi | 有効期限。発行するワンタイム APPKEY の使用期限を指定します。省略時は、30000（30 秒）が設定されます。 | |
| ipa | 接続元IPアドレス。ワンタイム APPKEY を利用できるクライアントのIPアドレスに制限を設けることができます |
注記
サービスパスワードとマイページへのログイン用のパスワードは異なります。
有効期限
以下のいずれかを指定することができます。
- 数値。ミリ秒単位の使用期限となります。
- 's' (秒間)、'm' (分間)、'h' (時間)、'd' (日数)、'w' (週間) を単位とする文字列。例えば、以下のように指定できます。
5m 5 分間
2h 2 時間
100d 100 日間
yyyy(/|-)mm(/|-)dd[( |T)hh:mm:ss[.sss][[ ](Z|(+|-)zz[[:]zz])]]形式の時刻を表す文字列。例えば、以下のように指定できます。
2021/06/30 2021年6月30日 24時0分0秒 (2021年7月1日 0時0分0秒) まで有効
2021/07/00 2021年6月30日 24時0分0秒 (2021年7月1日 0時0分0秒) まで有効
2021/05/15 12:05:30 2021年5月15日 12時5分30秒 まで有効
接続元IPアドレス
以下のいずれかを指定することができます。
- 空文字列
- スペースまたは , (カンマ)を区切り文字とする複数の IPv4 CIDR 形式の IP アドレスを表す文字列。例えば、以下のように指定できます。
10.1.2.34
192.168.0.0/16
150.249.206.220 150.249.236.100/31
レスポンス
成功時
ワンタイム APPKEY 文字列を返します。
失敗時
何も返しません。必須項目が指定されていない可能性がありますので、クエリパラメータをチェックしてください。
注意
リクエストに含まれるサービス ID やサービスパスワードが間違っている場合でも、ワンタイム APPKEY が発行されます。この不正なワンタイム APPKEY を使用して音声認識サービスに接続すると、認証エラーになります。