プラットフォームAPI

まずお読みください
  クイックスタートと制限   API レスポンス形式
チャンネル管理
  チャンネルアイコンアップロード   チャンネルアイコンアップロード（ファイル）   チャンネル表示   チャンネル取得
チャンネルフィード管理
  MQTT リアルタイムフィードトピック   自動同期 Google スプレッドシート   HTTP インタラクション   チャンネルフィードデータ転送   CSVからのフィードインポート   チャンネルフィード概要取得   チャンネル表示   チャンネル取得
チャンネルコマンド
  コマンド追加
APIキー管理
  チャンネル読み取り専用キー削除   チャンネル読み取り専用キー生成   チャンネル書き込みキー生成   アカウントキーの生成   チャンネル API キー一覧

デバイス API

  デバイスエラーの種類   シリアル API

認証とコンプライアンス

  温度校正   UbiBot クラウドストレージアーキテクチャ   UbiBot GDPR プライバシー通知   FDA 21 CFR パート11   関連産業規格

チャンネル API キー一覧

概要

この API コールは、指定されたチャンネルに関連付けられたすべての API キーの一覧を返します。

 

API URL

https://webapi.ubibot.com/channels/CHANNEL_ID/api_keys?action=list&parameters  

CHANNEL_ID は対象チャンネルの ID，parameters は以下で定義されるパラメータ。

 

HTTP メソッド

GET

 

URL パラメータ

名前 型 必須 説明
account_key String 必須 Web コンソールから取得した account_key を指定

 

レスポンス

成功したリクエストには HTTP ステータスコード 200 が返されます。メッセージ本文には、指定されたチャンネルのすべての API キーを含む JSON オブジェクトが返されます。

エラー:  詳細は別途用意されたエラーコード一覧を参照してください。

補足  write_key はチャンネルおよびそのフィードの更新に使用されます。各チャンネルには 1 つの write_key が存在します。read_key はチャンネルのメタデータを読み取るために使用されます。各チャンネルは最大 10 個の read_keys を持つことができます。これらは一覧として返されます。

 

例

GET https://webapi.ubibot.com/channels/CHANNEL_ID/api_keysaction=list&account_key=xxxxx-xxxxx-xxxxx-xxxx

レスポンスは、write_key と利用可能な read_keys のリストを含む JSON オブジェクトです。例えば：

{"
 result": "success",
 "server_time": "2017 - 09 - 04 T08: 23: 16 Z",
 "write_key": "XXX5af4b4e43b2xxx30f584XX587",
 "read_keys": [{"
 read_key": "5972 XXX478bd4xxf3d0X28a9X",
 "note": null,
 "created_at": "2017 - 09 - 04 T05: 49: 37 Z",
 "updated_at": "2017 - 09 - 04 T05: 49: 37 Z"
 }]
}
ブログに戻る