利用準備

本章では、CWS APIを利用するまでに必要な作業について記載しています。

CWS APIを利用するには、CWS APIの基礎知識に記載しているデベロッパー・アプリケーションを用意する必要があります。

これはmimiの操作が必要となるため、まずはmimi consoleを利用してmimiの操作をします。

利用申込書の用意がありますので、そちらに記入の上、申込ください。利用申込書のフォーマットについては別途お問い合わせください。

弊社で利用準備が完了しましたら、完了連絡を差し上げます。

CWS APIでTHINKLETを使用する場合、THINKLETは通信できる状況になっている必要があります。最初の通信のセットアップは環境に合わせて設定をお願いします。

上記を行うための方法など、THINKLETの開発・操作に関する情報はTHINKLET開発者ポータルを参照ください。

APIの利用方法

CWS APIでは、それぞれのAPIの呼び出しに必要なスコープを定義しています。各APIで必要なスコープが異なりますので、使用するAPIに合わせてスコープを指定ください。詳細はAPIリファレンスをご確認ください。

スコープを指定してアクセストークンを発行すると、指定されたスコープのみ利用できるアクセストークンが発行されます。

アクセストークンの発行と利用については、認証認可を確認ください。

CWS APIを利用するために必要なスコープについては以下をご確認ください。なお、CWS APIのスコープについてはお申し込みがないとご利用いただけません。

詳しくは CWS API利用申し込みをご確認ください。

CWS APIで利用するスコープの一覧

スコープURI	スコープの概要
`https://apis.mimi.fd.ai/auth/thinklet/applications.w`	アプリケーションレベルの書き込み権限
`https://apis.mimi.fd.ai/auth/thinklet/applications.r`	アプリケーションレベルの参照権限
`https://apis.mimi.fd.ai/auth/thinklet/devices.w`	デバイスの書き込み権限
`https://apis.mimi.fd.ai/auth/thinklet/devices.r`	デバイスの参照権限
`https://apis.mimi.fd.ai/auth/thinklet/communication-service`	遠隔支援（WebRTC）利用権限

CWS APIの認証・認可には音声クラウドAPIサービスmimiと同じものを利用しています。

mimiの認証基盤へアクセストークンを発行するためのAPIを呼び出し、そのアクセストークンをCWS APIのリクエストヘッダに付与してリクエストを行ってください。

CWS APIで利用するためのmimiのIDは application を使用してください。トークン取得についても同様です。

mimiの認証・認可についての説明、具体的なアクセストークン発行手順については以下をご確認ください。

CWS APIを呼び出す際の、アクセストークンのリクエストヘッダへの付与例は以下です。

curl -sSv -X GET https://apis.thinklet.fd.ai/path_to_api \
-H "Authorization: Bearer {mimiのAPIを呼び出して取得したアクセストークン}" | jq .

APIリファレンスはこちらをご確認ください。