Magidoc

SMARTIO API

SMARTIOデバイス(BSMT-R4P4)はカスタム操作画面の作成や、外部アプリケーションと連携するためのGraphQL APIを提供しています。
このサイトでは、APIの利用方法や、開発に必要な情報をご紹介します。

GraphQLについては、GraphQL 公式サイトをご参照ください。

APIの利用について

#

SMARTIOでは、ローカルAPIおよび、クラウドAPIの2種類のAPIを提供しています。
ご利用の環境や目的に応じて、適切なAPIをご利用ください。

ローカルAPI

#

SMARTIOが接続されたローカルネットワーク内からのみ利用可能です。
同一拠点に設置された複数のSMARTIOをまとめて制御する場合や、設定を一括で行う場合などにご活用ください。

ローカルAPIのご利用方法は、 こちら をご覧ください。

クラウドAPI

#

インターネット経由でAPIを実行します。
遠隔地のSMARTIOを制御する場合や、多拠点に設置されたSMARTIOを一元管理する場合にご活用ください。

ご利用には、Microsoft Azureの契約が必要となります。

クラウドAPIのご利用方法は、 こちら をご覧ください。

クエリを作成する

#

GraphQL Playground

#

GraphQL Playgroundでは実際にクエリを実行させて、デバイスの状態取得や制御を行うことができます。
APIで実行するクエリの動作確認や、クエリの作成にご活用ください。

GraphQL Playgroundにアクセスするには、SMARTIOが接続されたローカルネットワーク内から以下のURLにアクセスしてください。

    
  

SMARTIOのアドレス には、対象となるSMARTIOデバイスのIPアドレス またはホスト名 + .local をご指定ください。

初回アクセス時は認証が求められますので、 APIが実行可能なユーザの認証情報 を入力してください。
認証が完了すると、以下のような画面が表示されます。

GraphQL Playground

左側のクエリエディタにクエリを入力し、実行ボタンを押すことで、クエリの動作確認を行うことができます。

GraphQL Playground

GraphQL リファレンス

#

本サイトにはSMARTIOが提供しているQueriesおよびMutationsのリファレンスを掲載しています。
クエリの作成時にご活用ください。