概要
CWS APIサービス概要
CWS APIは、THINKLETに対する各種設定やTHINKLETからのデータ取得を実現するためのWeb APIを提供しています。
CWS APIを用いることでTHINKLETのデバイス管理・THINKLETを用いた開発をより行いやすくします。
CWS APIで実現できること
CWS APIでの提供機能
CWS APIでは次の機能を提供しています。
- システム連携設定機能（Webhook URLの設定）
- THINKLETの利用有効化・利用無効化
- THINKLETへの各種設定機能（Wi-Fi / APN設定 / 言語設定 / Bluetooth）
- THINKLETのバージョンアップ機能（ソフトウェア / ファームウェア）
- THINKLETへ配信するソフトウェアの登録
- THINKLETを使った遠隔支援（WebRTC）機能
- THINKLETのデータ取得機能
- THINKLETへの任意の処理依頼
- THINKLETのハードウェアキー動作設定
- THINKLETからのファイルアップロード機能
- THINKLETの初期化
- システム利用実績取得
CWS API利用時のシステムイメージ
ユーザーはデバイスを直接操作せずとも各デバイスに対してネットワーク設定・バージョンアップなどの操作をCWS API経由で実現できます。
CWS APIの実行結果は、APIのレスポンスもしくはシステム連携設定機能で指定したWebhookにて通知として受信できます。
デバイスで発生した状態変更・イベントについても、同様の機能で指定したWebhookにて通知として受信できます。
CWS APIの基礎知識
CWS APIで登場する基本的な用語やリソースの関係性について、本章で説明します。
用語
| 用語 | 説明 |
|---|---|
| デベロッパー | CWS APIを利用する開発者または企業です。mimiのアカウント（メールアドレス）単位で生成されます。 |
| アプリケーション | ひとつの製品・環境を表します。CWS APIではmimiのアプリケーションIDのことを指します。 アプリケーションにはデバイスやソフトウェア・ファームウェアの配信を含むアプリケーションに対する設定が関連します。 |
| デバイス | THINKLETを指します。CWS APIではIMEIでデバイスを区別します。 デバイス毎に、インストールされているソフトウェア・ファームウェアのバージョンを管理します。 |
| トランザクション | ユーザーがCWS APIを呼び出して、デバイスに処理依頼する単位を表します。CWS API利用時のシステムイメージ も一緒にご確認ください。 これらの応答結果は、システム連携設定 で設定したWebhook URLで受け取る事ができます。 |
| authenticationKey | CWS APIと利用者との間で正しい通信であると証明するためのキーです。この値は利用者毎に異なります。 詳しくは authenticationKey を発行する を確認してください。 |
| アクセストークン | CWS APIを利用するために必要な認証情報です。詳しくは認証認可を確認してください。 |
| アクティベート・ディアクティベート | アクティベートとは、指定のデバイスを指定のアプリケーションに関連付けをしてCWS APIで利用可能な状態にする事です。その逆の操作をディアクティベートと呼びます。 |
| Sora | 時雨堂社が提供しているWebRTCを用いたリアルタイム映像通信のソフトウェアです。 |
mimiに関連する内容については以下をご確認ください。
基本概念
CWSのリソースの関連性は、 デベロッパー > アプリケーション > デバイス と階層構造となっています。
アプリケーションにはシステム連携設定、デバイスにはネットワーク設定・端末状態・インストールしたソフトウェアやファームウェアのバージョン情報などが関連しています。
前述の用語を踏まえたリソースの関係性については下図のとおりです。
