Web API

紹介

Sesame RESTful webAPI を使用するために、API KEY の取得が必要です。WebAPI ができること

Sesame の状態を取得
Sesame の履歴を取得
Web API による施解錠

Sesame の状態を取得

GET: 'https://app.candyhouse.co/api/sesame2/{sesame2_uuid}'
Parameters: (name = 'x-api-key'), (location = 'header'), (des = 'your api-key')
;(name = 'sesame2_uuid'), (location = 'path'), (des = 'sesame UUID')

Response

{
   "batteryPercentage":94,             // 電池残量94%
   "batteryVoltage":5.869794721407625, // 電池の電圧, 単位: ボルト(V)
   "position":11,                      // セサミデバイスの角度, 360˚ は 1024
   "CHSesame2Status":"locked",         // locked | unlocked | moved
   "timestamp":1598523693              // Sesame Shadow が更新された時間。 1970/1/1 00:00:00 からミリ秒単位のタイムスタンプ
}

Sesame の履歴を取得

GET: 'https://app.candyhouse.co/api/sesame2/488ABAAB-164F-7A86-595F-DDD778CB86C3/history?page=0&lg=2'
Parameters: (name = 'x-api-key'), (location = 'header'), (des = 'your api-key')
;(name = 'sesame2_uuid'), (location = 'path')
;(name = 'page'),
  (location = 'query'),
  (des =
    'ページ数。ページ数の0から、新→旧の履歴順番で、1ページの中に最多50件の履歴が入ってる。')
;(name = 'lg'),
  (location = 'query'),
  (des = '指定されたページの中に、新→旧の履歴順番で取得したい履歴件数。')

Response

;[
  {
    type: 2,
    timeStamp: 1597492862.0, // 1970/1/1 00:00:00 からミリ秒単位のタイムスタンプ
    historyTag: '44OJ44Op44GI44KC44KT', // 鍵に付いてるタグやメモ 0 ~ 21bytes
    recordID: 255, // 連続でない(将来、連続になるように修正する予定)、セサミデバイスが再起動するまで当履歴の唯1つのID、 小→大
    parameter: null, // 解析する予定
  },
  {
    type: 11,
    timeStamp: 1597492864.0,
    historyTag: null,
    recordID: 256,
    parameter: null,
  },
]

type :

    0 none.
    1 bleLock.                セサミデバイスが 施錠のBLEコマンド を受付ました。
    2 bleUnLock.              セサミデバイスが 解錠のBLEコマンド を受付ました。
    3 timeChanged.            セサミデバイスの内部時計が校正された。
    4 autoLockUpdated.        オートロックの設定が変更されました。
    5 mechSettingUpdated.     施解錠角度の設定が変更されました。
    6 autoLock.               セサミデバイスがオートロックしました。
    7 manualLocked.           手動で施錠 (下記  ケース2またケース3 から ケース1 になった場合 )
    8 manualUnlocked.         手動で解錠 (下記  ケース1またケース3 から ケース2 になった場合 )
    9 manualElse.             解錠の範囲または施錠の範囲から、サムターンに動きがあった場合（下記 　ケース１からケース３になった場合、またはケース２からケース３になった場合）
   10 driveLocked.            モーターが確実に施錠しました。
   11 driveUnlocked.          モーターが確実に解錠しました。
   12 driveFailed.            モーターが施解錠の途中に失敗しました。
   13 bleAdvParameterUpdated. セサミデバイスが発信しているBLEアドバタイシング の Interval と TXPower の設定が変更されました。
   14 wm2Lock.                Wifiモジュールを経由してセサミデバイスを施錠しました。
   15 wm2Unlock.              Wifiモジュールを経由してセサミデバイスを解錠しました。
   16 webLock.                Web APIを経由してセサミデバイスを施錠しました。
   17 webUnlock.              Web APIを経由してセサミデバイスを解錠しました。


補足１：現時点では状態は以下の３つのみとなっています。
  ＜ケース１：施錠＞
    サムターンが施錠の範囲にある場合、
    施錠　1
    解錠　0　
  ＜ケース２：解錠＞
    サムターンが解錠の範囲にある場合、
    施錠　0
    解錠　1
  ＜ケース３：それ以外（※現時点では「解錠」とUI上で表示しています。 ＞
    サムターンが以上の２範囲以外にある場合、
    施錠　0
    解錠　0

Web API による施解錠

Sesameの鍵とタイムスタンプで、AES-CMAC 署名。 WiFi モジュール 2 と繋がっている Sesame に施解錠のリクエストをする。

REST スキーマ
Sesame の状態を取得
コマンドコードリスト
AES-CMAC 使用方法
コード用例

REST スキーマ

POST: "https://app.candyhouse.co/api/sesame2/${sesame_id}/cmd"
BODY: {
        cmd: cmd,
        history: base64_history,
        sign: sign
}
Parameters:
    name = "x-api-key", location = "header",des="your api-key"
    name = "sesame2_uuid", location = "path"
    name = "cmd", location = "body",des="開閉コマンドコード"
    name = "history", location = "body",des="履歴"
    name = "sign", location = "body",des="署名"

コマンドコードリスト

toggle:88
lock:82
unlock:83

AES-CMAC 使用方法

暗号化の使用,AESCMAC(key, message)
key は getkey で取得した key-secret とのセサミの鍵
message はタイムスタンプ (SECONDS SINCE JAN 01 1970. (UTC)) --> 2.uint32 (little endian) --> 3.remove most-significant byte

コード用例

const axios = require('axios')
const aesCmac = require('node-aes-cmac').aesCmac

let wm2_cmd = async () => {
  let sesame_id = '3DE4DE72-AAF9-25C1-8D0F-C9E019BB060C'
  let key_secret_hex = 'a13d4b890111676ba8fb36ece7e94f7d'
  let cmd = 88 //(toggle:88,lock:82,unlock:83)
  let base64_history = Buffer.from('test2').toString('base64')

  let sign = generateRandomTag(key_secret_hex)
  let after_cmd = await axios({
    method: 'post',
    url: `https://app.candyhouse.co/api/sesame2/${sesame_id}/cmd`,
    headers: { 'x-api-key': `M10YD4NKnP3BzIraDzINg9vcjOzEc2uP3DWb2HJn` },
    data: {
      cmd: cmd,
      history: base64_history,
      sign: sign,
    },
  })
}

function generateRandomTag(secret) {
  // * key:key-secret_hex to data
  let key = Buffer.from(secret, 'hex')

  // message
  // 1. timestamp  (SECONDS SINCE JAN 01 1970. (UTC))  // 1621854456905
  // 2. timestamp to uint32  (little endian)   //f888ab60
  // 3. remove most-significant byte    //0x88ab60
  const date = Math.floor(Date.now() / 1000)
  const dateDate = Buffer.allocUnsafe(4)
  dateDate.writeUInt32LE(date)
  const message = Buffer.from(dateDate.slice(1, 4))

  return aesCmac(key, message)
}

wm2_cmd()

import datetime, base64, requests, json
from Crypto.Hash import CMAC
from Crypto.Cipher import AES

uuid = '3DE4DE72-AAF9-25C1-8D0F-C9E019BB060C'
secret_key = '2ebc2c087c1501480834538ff72139bc'
api_key = 'SrSOEY9mBe6Ndl7bwyVPs5TsTPFTEq9tra8Occad'

cmd = 88  # 88/82/83 = toggle/lock/unlock
history = 'test5'
base64_history = base64.b64encode(bytes(history, 'utf-8')).decode()

print(base64_history)
headers = {'x-api-key': api_key}
cmac = CMAC.new(bytes.fromhex(secret_key), ciphermod=AES)

ts = int(datetime.datetime.now().timestamp())
message = ts.to_bytes(4, byteorder='little')
message = message.hex()[2:8]
cmac = CMAC.new(bytes.fromhex(secret_key), ciphermod=AES)

cmac.update(bytes.fromhex(message))
sign = cmac.hexdigest()
# 鍵の操作
url = f'https://app.candyhouse.co/api/sesame2/{uuid}/cmd'
body = {
    'cmd': cmd,
    'history': base64_history,
    'sign': sign
}
res = requests.post(url, json.dumps(body), headers=headers)
print(res.status_code, res.text)


# certifi==2021.5.30
# chardet==4.0.0
# clr==1.0.3
# idna==2.10
# Naked==0.1.31
# pycryptodome==3.4.3
# PyYAML==5.4.1
# requests==2.25.1
# urllib3==1.26.6

Web API

紹介

Sesame の状態を取得

Sesame の履歴を取得

Web API による施解錠

REST スキーマ

コマンドコードリスト

AES-CMAC 使用方法

コード 用例

コード用例