アプリケーション開発

JavaScript SDK編

SDK 概要

JavaScript SDK は、IoTアクセス制御エンジンの Web API v2 を簡単に扱えるようにする JavaScript ライブラリです。JavaScript SDK を使うことで、IoTアクセス制御エンジン の Web API v2 の仕組みや認証シーケンスなどを意識することなく、簡単な JavaScript コードでIoTアクセス制御エンジンへのアクセスを可能とし、アプリケーション開発を手助けします。

SDKはダウンロードページよりダウンロードできます。

対象ブラウザー

SDK がサポートするブラウザーは以下の通りです。

  • Google Chrome
  • Mozilla Firefox
  • Apple Safari
  • Microsoft Edge
  • Microsoft Internet Explorer 11

インストール

SDK に同梱されている symphony-sdk フォルダを Web サーバーにアップロードします。Web サーバーは SSL/TLS でなければいけませんので注意してください。以降、symphony-sdk フォルダの URL は以下の通りとします：

https://example.jp/symphony-sdk/

symphony-sdk フォルダには以下の 3 つのファイルが含まれています。すべてのファイルをサーバーにアップロードしてください。

  • symphony-sdk.js
  • auth_callback.html
  • signup_callback.html

ダッシュボードを構成する HTML には、以下の通り、script 要素を使って symphony-sdk.js を読み込むようにします。ただし、Internet Explorer 11 をサポートしたい場合は、symphony-sdk.js を読み込む前に、es6-promise.auto.min.js を読み込むようにしてください。

<script src="https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.min.js"></script>
<script src="/symphony-sdk/symphony-sdk.js" data-dsymphony="sdk-js"></script>

script 要素の src 属性には、symphony-sdk フォルダに入っている symphony-sdk.js の URL をセットします。また、 script 要素には必ず data-symphony 属性に sdk-js をセットしてください。この属性をセットしないと正しく動作しませんので注意してください。

アクセス許可申請

Symphony は、ダッシュボードからサインアップおよびサインインのリクエストを受けた際に、ダッシュボード側にリダイレクトを何度か繰り返します。そのリダイレクト先 URL を Symphony のホワイトリストに登録してもらうよう、事務局に申請する必要があります。申請する URL は以下の 2 つです：

  • https://example.jp/symphony-sdk/auth_callback.html
  • https://example.jp/symphony-sdk/signup_callback.html

FQDN (example.jp の部分) と symphony-sdk フォルダまでのパスについては、あなたの環境に合わせて読み替えてください。

auth_callback.html と signup_callback.html の URL が Symphony のリダイレクト先 URL のホワイトリストに登録されるまでは、ダッシュボードからサインアップおよびサインインができませんので注意してください。

アクセス許可申請が終わると、クライアント ID が事務局から通知されます。このクライアント ID はダッシュボード開発で必要となります。

アプリケーション開発