IoT Platform:プロダクトデータ API

前提条件

プロダクトとデバイスを作成しておく必要があります。詳細については、「プロダクトの作成」および「デバイスの作成」をご参照ください。

プロダクトデータ API の作成

1. IoT Platform コンソールで、[概要] ページに移動し、対象の Enterprise Edition インスタンスの [ID] またはエイリアスをクリックします。

2. 左側のナビゲーションペインで、[データサービス > データ API] を選択します。

3. [Product Data API] タブをクリックし、[API の作成] をクリックします。

4. [API の作成] パネルで、対象の製品の横にあるチェックボックスを選択します。

5. [適用] をクリックします。

   プロダクトのスナップショットデータ API、生データ API、およびイベントデータ API がプロダクトデータ API リストに追加されます。

   パラメーター	スナップショットデータ API	生データ API	イベントデータ API
   API 名	${productName} product snapshot data query	${productName} product raw data query	${productName} product event data query
   API パス	/${productKey}/snapshot/data/get	/${productKey}/rawdata/get	/${productKey}/event/data/get

   ${productName} はプロダクト名、${productKey} はプロダクトの一意の識別子です。

プロダクトデータ API の編集

スナップショットおよび生データクエリ API については、API 名、リクエストパラメーター、およびレスポンスパラメーターを編集できます。

1. [データ API] ページで、[製品データ API] タブをクリックします。

2. API リストで、対象の製品のスナップショットまたは生データのクエリ API を見つけ、[アクション] 列の [編集] をクリックします。

3. [API の編集] ウィザードで、[API の基本情報] を変更し、[次へ] をクリックします。

   パラメーター	説明
   API 名	API の名前を変更します。名前には、中国語、英字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。名前は最大 30 文字です。
   API パス	このパラメーターは変更できません。
   API タグ	タグの内容を入力し、Enter キーを押してタグを作成します。 タグには、中国語、英字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。各タグは最大 30 文字です。 タグを使用すると、API にカスタム ID を追加して柔軟に管理できます。 重要 1 つの API に追加できるタグは最大 5 つです。
   API の説明	API の機能やその他の情報を説明する説明を入力します。
   戻り値の型	API が呼び出された後に返されるデータの形式です。これは JSON に固定されています。

4. [パラメーターの設定とテスト] ページで、設定パラメーターと詳細設定を変更します。

   カテゴリー	設定項目	説明
   設定パラメーター	リクエストパラメーター	[パラメーターの追加] をクリックし、[バインドフィールド] を選択します。 追加したパラメーターでは、演算子の設定、必須かどうかの指定、サンプル値と説明の入力ができます。 パラメーターを削除するには、削除アイコン をクリックします。 重要 パラメーターのタイプが数値の場合、LIKE 演算子はサポートされません。
   	レスポンスパラメーター	デフォルトでは、API が返すことができるすべてのフィールドが選択されています。フィールドをソートに使用するかどうかを指定し、サンプル値と説明を入力できます。 パラメーターを削除するには、削除アイコン をクリックします。パラメーターを削除した後、[パラメーターの追加] をクリックして、バインドされたフィールドをレスポンスパラメーターとして再度追加できます。また、右側にある [すべてのパラメーターを選択] チェックボックスをオンにして、すべてのフィールドをレスポンスパラメーターとして再選択することもできます。 説明 [並べ替えに使用] は、クエリ結果が返される前に、クエリされたデータがこのフィールドの値で昇順または降順に並べ替えられることを指定します。
   	ソート順	データのソート順を選択します。 [昇順] (デフォルト): パラメーターは昇順にソートされます。 [降順]: パラメーターは降順にソートされます。
   詳細設定	結果のページングを有効にする	返される結果のページングを有効にするかどうかを選択します。 [無効]: 最大 100 件の結果を表示できます。 [有効]：すべての結果をページで表示できます。この機能を有効にすると、次の共通パラメーターが自動的に追加されます： pageNum：ページ番号。 pageSize：各ページに表示される結果の数。最大値は 100 です。
   	タイムアウトエラー設定	API 呼び出しリクエストが 8000 ミリ秒を超えると、タイムアウトエラーが返されます。このパラメーターは変更できません。

5. 設定が完了したら、[API のテスト] セクションで、リクエストパラメーターにテスト値を入力し、[テストを開始] をクリックします。

   [レスポンス例] タブではサンプルデータを、[リクエスト詳細] タブではリクエストの詳細を表示できます。

   リクエストパラメーターには、pageNum (INTEGER)、pageSize (INTEGER)、timestamp (BIGINT、必須)、および device_name (VARCHAR) が含まれます。レスポンス例の JSON 形式のデータには、date_time、ActivePower、LightVolt、PowerRatio、DrainVoltage、PowerConsumption、LightAdjustLevel、timestamp、device_name、iot_id、LightCurrent、LightStatus など、IoT デバイスの電力と照明ステータスに関連するフィールドが含まれています。

6. [発行] をクリックします。

   重要

   • 公開する前に、API がテストに合格していることを確認してください。

   • API に対して [保存] のみをクリックした場合、[API 詳細] ページの [ステータス] は [未公開] になります。

   • データをクエリするために API を呼び出すには、API を公開する必要があります。

   API が公開されると、成功メッセージが表示され、[API 名] と [API パス] が表示されます。[コピー] をクリックしてパスをコピーできます。ページの下部には、Java SDK、Node.js SDK、および Python SDK の呼び出し例が記載されています。[リストを表示] をクリックして API リストに戻るか、[再度作成] をクリックして別の API を作成できます。

次のステップ

• プロダクトデータ API を呼び出して、プロダクト内の特定のデバイスの生データ、スナップショット、およびイベントデータを表示します。

  呼び出し例については、以下をご参照ください。

  • Java SDK の呼び出し例

  • Node.js SDK の呼び出し例

• [API 詳細] ページで API の使用状況を表示できます。詳細については、「API を表示する」をご参照ください。