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

チュートリアル

本章では、CWS APIの基本的な利用方法について記載しています。

mimi アクセストークンの発行​

API認証 の記載に基づき、アクセストークンを発行してください。CWS APIの利用のために必要です。

システム連携設定​

CWS APIで管理しているデバイスで発生したイベントやCWS APIから指示したそのデバイスへの処理の結果を、利用者が用意したWebhookで受け取ることができます。

通知・アクセス設定 APIでWebhook URLを指定して、そのイベントを受け取るためのURLを設定します。

まずは deviceEvent を設定して、デバイスで発生したイベントを受け取ってみましょう。

安全な利用のために​

CWS APIはシステム連携設定で設定されたWebhook URLを呼び出す際、その通信がCWS APIからの通信である事を証明するための情報を付与します。

その値を用いて、Webhook URLを受け取った際にセキュリティ観点で正しい通信かを検証することを推奨します。

まずは、authenticationKey を発行する のAPIを呼び出し、authenticationKey を発行してください。

これ以降、CWS APIが設定されたWebhook URLを呼び出す際には、authenticationKey を付与します。

備考

検証方法については、authenticationKeyの検証方法 を確認してください。

デバイスの利用開始​

CWS APIでTHINKLETを利用する場合、あらかじめ通信可能な状態へ設定してください。設定方法はデバイス準備を参照してください。

デバイスに対して操作する・デバイスの状態変更を受け取る場合は、デバイスへのアクティベートを行う必要があります。

デバイスをアクティベートする APIを利用して、デバイスをアクティベートしてください。

この時、デバイスがインターネット接続されていれば、Webhookでトランザクションの結果を受け取ることができます。

デバイスの活用​

アクティベート後はデバイスに対しての動作指示や、デバイスの状態取得が可能になります。APIやWebhookをご利用ください。

ソフトウェアアップデートについてはソフトウェアをアップロードするためのURLを作成する を参考に、配信するアプリケーションの情報とアプリケーション本体をご登録ください。

ファームウェアアップデートについては弊社から共有された情報で適宜実施ください。

デバイスの利用終了​

デバイスを利用しない場合は、適宜ディアクティベート・初期化を行ってください。

  • ディアクティベート
    • デバイスをディアクティベートする APIを呼び出す事で、デバイスへディアクティベート依頼が送信される
    • ディアクティベート完了後、デバイスに対する操作するAPIが利用不可となり、該当デバイスに関するWebhookは送信されない
    • 利用を再開する場合は、再度デバイスをアクティベートする APIを呼び出す
    • デバイスへインストールしたアプリケーションや保存済みの設定は削除されない
  • 初期化
    • デバイスの初期化 APIを呼び出す事で、デバイスへ初期化依頼が送信される
    • 初期化が完了すると、CWS APIとしてはディアクティベートと同じ状態になる
    • 前記に加え、ファクトリリセットと同等の挙動（ファームウェアは最新のまま）となり、それ以外のデータがすべて削除される

デバイス状態変更検知・処理結果通知​

システム連携設定 で記載した内容の通り、デバイスで発生した情報を受信できます。

それぞれのイベント詳細は、DeviceEvent を確認ください。

たとえば、次の情報を受け取ることができます。

  • 電源オン／オフ
  • オンライン・オフライン、ネットワーク強度
  • 装着状態
  • 位置情報
  • バッテリー（充電状態、残量）
  • 音量変更
  • Bluetoothデバイス接続／切断

遠隔支援機能​

CWS APIでは Sora をホスティングしており、ご利用可能です。

詳しくは 遠隔支援の利用 を参照してください。

端末で任意の動作を行う機能​

デバイスでコマンドを実行させる APIを利用することで、端末へ任意の動作をするための情報を送信できます。

利用者側でソフトウェアをインストールした後に、このAPIを用いて遠隔から操作が可能です。

困った時は​

利用に際して問題・質問等がありましたら、こちら から弊社までお問い合わせください。

その際、次の情報をいただけますと確認がスムーズに進みますので、ご協力お願い致します。

  • 事象発生日時
  • 事象の内容
  • 利用中のapplicationId
  • API実行時のトランザクションID
  • 該当デバイスのIMEI
  • 遠隔支援の利用時
    • ChannelID
    • ClientID
    • Endpoint