外部連携API

Arsproutクラウド内に蓄積されたデータを外部システムと連携するためのREST形式のAPIです。本機能をご利用になるには、別途オプション契約(有償)が必要ですのでお問い合わせください。

共通仕様

項目内容
プロトコルHTTPS (ポート 443)
データフォーマットJSON形式
文字コードUTF-8
認証方式・Basic認証
[認証ID] クラウドログインIDと共通
[パスワード] クラウドログインパスワードもしくはAPI専用パスワード

・Bearer トークン方式
取得したトークンをAuthorizationヘッダに「Bearer `token`」をセット
日時のフォーマット
ISO 8601形式
ISO 8601形式
(例)「日本時間(JST)の2012年3月22日14時17分」
→ 2012-03-22T14:17:00+09:00
(クエリパラメータとして利用する場合は
”+”をエスケープして”%2B”に置換すること)
アクセス頻度の上限5分に1回を目安とする

アクセストークン取得API

項目内容
URIhttps://cloud.arsprout.net/app/arpi/jwt
HTTPメソッドPOST
認証方式Basic認証
レスポンスプレーンな文字列形式
トークン有効時間1時間

以下APIにて、Basic認証でのアクセス数が膨大な場合、Bearerトークンによる認証への移行をお願いする場合があります。

計測データ取得API

項目内容
基本URIhttps://cloud.arsprout.net/app/uecs/ccm
HTTPメソッドGET
パスパラメータ(任意)[基本URI]/{room}/{region}/{order}/{type}
パス形式で情報絞り込みが可能です。無指定のデフォルトはすべてのCCM情報が対象になります。
・room : 0-127
・region : 0-127
・order : 0-30000
・type : CCM識別子(InAirTemp、InAirHumid.mIC 等)
クエリパラメータ(任意)[基本URI][パスパラメータ]?[クエリパラメータ]={値}&[クエリパラメータ]={値}...
・id : CCMのクラウド管理番号を指定します。(※1)
・from : 計測値データ取得の始点日時を指定します。(※2)
・to : 計測値データ取得の終点日時を指定します。(※2)
(※1)idが指定されると、パスパラメータの指定より優先されます。取得されるCCMは1個のみとなります。
(※2)指定されなかった場合は、計測データは取得されません。 1リクエストでの取得レコード数は最大5000件となりますので、
超過する場合はfrom/to指定で分割取得してください。
データサンプル
(任意)
[{
    "id" : "9050",
    "name" : "気温",
    "type" : "InAirTemp",
    "room" : "1",
    "region" : "3",
    "order" : "1",
    "cast" : "1",
    "unit" : "C",
    "value-set" : [ {
            "time" : "2016-09-19T15:25:00+09:00",
            "value" : "19.8"
        }, {
            "time" : "2016-09-19T15:30:00+09:00",
            "value" : "20.1"
        }, {
            "time" : "2016-09-19T15:35:00+09:00",
            "value" : "19.9"
        }]
        }, {
        "id" : "9054",
        "name" : "相対湿度",
        "type" : "InAirHumid",
        "room" : "1",
        "region" : "3",
        "order" : "1",
        "cast" : "0",
        "unit" : "%",
        "value-set" : [ {
            "time" : "2016-09-19T15:25:00+09:00",
            "value" : "75"
        }, {
            "time" : "2016-09-19T15:30:00+09:00",
            "value" : "76"
        }, {
            "time" : "2016-09-19T15:35:00+09:00",
            "value" : "78"
        }]
}]

計測データ登録API

項目内容
基本URIhttps://cloud.arsprout.net/app/uecs/ccm
HTTPメソッドPOST
データの説明(任意)HTTPのBODY部にJSON形式のデータを埋め込みます。id : [任意] 指定されると、既登録CCMとして更新処理となります。指定されなかった場合は、新規項目として登録されます。
・ name : CCM識別子(InAirTemp、InAirHumid.mIC 等)[新規登録は必須]
・ type : [新規登録時必須] CCM識別子 [新規登録は必須]
・ room : 0-127 [新規登録は必須]
・ region : 0-127 [新規登録は必須]
・ order : 0-30000 [新規登録は必須]
・ cast : 小数点以下桁数 [新規登録は必須]
・ unit : 単位(半角英数) [新規登録は必須]
・ value-set : 計測データ配列 [任意]
・ value-set[time] : 計測時刻
・ value-set[value] : 計測値
データサンプル
(任意)
[ {
    "id" : "9050",
     "value-set" : [ {
          "time" : "2016-09-19T15:40:00+09:00", "value" : "21.1"
          }, {
          "time" : "2016-09-19T15:45:00+09:00", "value" : "22.9"
     } ]
     }, {
     "name" : "気温(新規)",
     "type" : "InAirTemp",
     "room" : "2",
     "region" : "1",
     "order" : "1",
     "cast" : "1",
     "unit" : "C",
     "value-set" : [ ]
}]

HTTPステータス一覧

コード内容
200正常
400JSONパースエラー、日時フォーマットエラー
401ベーシック認証エラー
404APIリクエストパスエラー
405外部API連携オプション利用不可
500その他サーバエラー