メインコンテンツまでスキップ

API キー発行

API キー発行するためのエンドポイントを提供しています。マイページに記載されたサービスIDとサービスパスワードから API キーを発行できます。また、マイページ上で「API キー発行可能」と設定して発行した API キーでも、API キーを発行することができます。

  • API キーは、アプリケーションが AmiVoice API 音声認識サービスを利用するためのサービス認証キー文字列です。
  • 発行日時と有効時間にもとづいた有効期限日時や、利用可能な IP アドレスを必要に応じて設定することができます。

エンドポイント​

POST https://acp-api.amivoice.com/issue_service_authorization

リクエスト​

リクエストパラメータ​

パラメータ名
必須
説明
sid*1マイページの接続情報に表示される サービス ID を指定します。
authorization で API キーを指定する場合は、sid は指定しないでください。
spw*1マイページの接続情報に表示される サービスパスワード を指定します。
authorization で API キーを指定する場合は、spw は指定しないでください。
authorization*2マイページ上で「API キー発行可能」と設定して発行した API キーを指定します。Authorization ヘッダーに指定してください。
authorization を使用する場合は、sid と spw は指定しないでください。
epi有効期限。発行するAPI キーの使用期限を指定します。省略時は、30000（30 秒）が設定されます。
ipa接続元IPアドレス。API キーを利用できるクライアントのIPアドレスに制限を設けることができます
  • (*1) authorizationを指定しない場合は必須です。
  • (*2) sidとspwを指定しない場合は必須です。
注記

サービスパスワードとマイページへのログイン用のパスワードは異なります。

有効期限​

以下のいずれかを指定することができます。

  • 数値。ミリ秒単位の使用期限となります。
  • '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

レスポンス​

成功時​

API キー文字列を返します。

失敗時​

  • AuthorizationヘッダーがBearer で始まらない場合

ステータスコード 400 で以下のエラーメッセージが返ります

Invalid Authorization Header
  • authorization で指定した API キーが正しくない場合

API キーの認証ができず、ステータスコード 400 で以下のエラーメッセージが返ります

Invalid appkey
  • authorization で指定した API キーが、「API キー発行可能」と設定されていない場合、もしくは無効化されている場合

API キーを用いたサービスパスワードが取得できず、ステータスコード 400 で以下のエラーメッセージが返ります

Dont issue appkey
  • 何もレスポンスが無い場合

必須項目が指定されていない可能性がありますので、パラメータをチェックしてください。

注意

サービス ID やサービスパスワードが間違っていても、API キーが発行されます。この不正な API キーを使用して音声認識サービスに接続すると、認証エラーになります。エラーメッセージはインタフェースによって異なります。

HTTPインタフェースの場合​

サービス ID、サービスパスワードのいずれかが誤っている場合、以下のエラーを返します。

{
    "code":"-"
    "message":"received illegal service authorization"
}

WebSocketインタフェースの場合​

サービス ID、サービスパスワードのいずれかが誤っている場合、以下のエラーを返します。

s can't validate service authorization