Get Started

開発を始める最も簡単な方法は、提供されているWebベースのGraphQL IDEを使用することです。こちらからアクセスできます。
https://graphql-gateway.optisigns.com/graphql

また、アカウントへの認証を提供するためにAPIキーが必要です。APIキーの取得方法についてはこちらをご覧ください。

クエリとミューテーション

GraphQLは、データを操作するための2つの方法を提供します。クエリはサーバーからデータを読み取りまたは取得するために使用されます。ミューテーションはサーバーにデータを変更または投稿するために使用されます。

デバイスの取得

このクエリは、アカウントで利用可能なすべてのデバイスを一覧表示します。必要なフィールドを指定して、結果から返されるようにすることができます。

query{
  devices (query : {}) {
    page{
      edges{
        cursor,
        node{
          _id,
          deviceName,
          UUID,
          pairingCode,
          currentType,
          currentAssetId,
          currentPlaylistId,
          localAppVersion,
        }
      }
    }
  }
}

特定のアセットの取得

条件に従ってデータを取得したい場合は、引数を指定することで実行できます。このクエリは、アカウント内の「Houston Weather Test」という名前のアセットを取得します。

query{
  assets (query : {originalFileName:"Houston Weather Test"}) {
    page{
      edges{
        cursor,
        node{
          _id,
          appType,
          fileType,
          name,
          filename
        }
      }
    }
  }
}

前の記事 - APIキーの生成と管理

次の記事 - GraphQL APIチュートリアル：スクリーンへのペアリングとコンテンツの割り当て