Secure Connect API
Secure Connectアプリケーションプログラミングインターフェース (API) により、外部システムからSecure Connect データにアクセスすることができます。APIを通じて以下の情報にアクセスできます:
- アラームのデータ
- ライブデータ
- ステーションのデータ
- デバイスのデータ
- 顧客データ
- ユーザーデータ
Secure Connect APIは、データ受信にのみ使用されます。ユーザーは、外部クライアントを追加することで、Secure Connect APIを介してデバイスを制御したり、データを編集したりすることはできません。
外部クライアントの追加
- Secure Connectにログインします。
- Admin> Customersに移動します。
- お客様を選択します。
- 外部クライアントタブに移動します。
- 追加ボタンをクリックします。
- 名前を入力します。
- 説明を入力します。
説明を書くことは任意です。 - 保存をクリックします。
外部クライアントが作成され、ユーザーは一意のAuth0クライアントIDと1回限りのAuth0クライアントシークレットを受け取ります。クライアントシークレットは1回しか表示されないため、保存することが重要です。Secure Connect REST APIにアクセスするには、クライアントのシークレットが必要です。ユーザーがクライアントのシークレットを忘れた場合は、新しい外部クライアントを作成する必要があります。
APIドキュメント
Secure Connect APIドキュメントは、Secure Connectアプリケーションで入手できます。Secure Connect APIドキュメントにアクセスするには:
- Secure Connectアプリケーションにログインします。
- 右上隅のプロファイルアイコンをクリックします。
- 外部クライアントリソースをクリックします。
- APIリンクをクリックして、Secure Connect API YAMLファイルをダウンロードします。
ダウンロードしたファイルには、以下の情報が含まれています。
- REST APIパス
- リクエスト形式
- 応答形式
- スキーマ情報
Secure Connect認証メカニズムとSecure Connect APIの呼び出し方法の詳細については、外部クライアントリソースのインストールガイドリンクをクリックしてください。ダウンロードしたファイルには、以下の情報が含まれています。
- 外部クライアントの設定
- 認証用のJWTトークンの取得