[SaaSプラン]API仕様

SaaSプランをご利用いただく際には、このAPI仕様を参照ください。サンプルプログラムもご利用いただけます。

APIの種類

データ登録用のAPI機能のみを提供します。

API仕様

データ登録用のAPI接続情報です。

項目内容備考
アクセスURLhttps://iot.fanbright.jp/v1/enocean今後、変更の可能性があります。
HTTPメソッドPOST-
プロトコルHTTPSHTTPも利用できますが、HTTPSをお使いください。

APIパラメータ

POST送信時にパラメータの指定が必要です。送信パラメータは下記になります。

パラメータ意味値(例)説明
cust_id顧客ID10ログイン後のトップページから取得できる固定の数値
gateway_keyゲートウェイ認証キーe0a8aa1a4dログイン後のトップページから取得できる固定のランダム値
valueHEX値550007020a0a21040003e10949013ca1EnOceanシリアル値(下記のEnOceanセンサー情報を参照)
datetimeゲートウェイ検知日時2015-07-07 10:10:10EnOceanセンサーからのテレグラムをゲートウェイが検知した日時

Content-Typeは下記が使えます。

  • application/x-www-form-urlencoded
  • application/json

API応答

POST処理結果をJSON形式で返答します。

状態応答コード応答内容備考
OK200{'status'=>'OK'}message はありません。
NG400{'status'=>'NG','message'=>'****'}「****」はエラー内容に応じた可変文字列

EnOceanセンサー情報

対応しているEnOceanセンサー情報です。

センサーTypeEEPBytePacketType送信する値の例
STM429JD5-00-011BSRADIO_ERP2(0x0a)550007020a0a210400XXXX0822012bc4
STM431JA5-02-054BSRADIO_ERP2(0x0a)55000a020a9b220400XXXX000052083e012ac3
EOSWJA5-07-014BSRADIO_ERP2(0x0a)55000a020a9b220400XXXXc51dff09c8013790
PTM210JF6-02-04RPSRADIO_ERP2(0x0a)550007020a0a2000298f1200620129ca
STM431J+HSM100A5-04-014BSRADIO_ERP2(0x0a)55000a020a9b2204005036007cb40af60129ca
ETM500JA5-02-054BSRADIO_ERP2(0x0a)55000a020a9b2204004f3f000047093c013182

  • HeartBeat値は送信してください。HeartBeat間隔を変更する際には、5分間隔以上で設定してください。
  • Dataテレグラム、Teach-inテレグラム(LRN) をそのまま送信してください。
  • LRNボタン押下時にセンサーを登録する時には、LRNボタン押下時のシリアル値を使います。
  • クラウド側では、HeaderとDataのCRCチェックは行いません。IoTゲートウェイ機器側でチェックしてください。
  • 本サービスで登録しないEnOceanセンサーの値は、クラウド側に送信しないようにゲートウェイ側でフィルタリングして除外してください。