【完走賞ゲット-17】SwitchBot の新バージョンAPI v1.1 の情報を調べてみたり旧バージョンの API も見てみたり

Last updated at 2022-12-17Posted at 2022-12-17

はじめに

こちらは、完走賞ゲットのため小ネタを毎日投稿しようとチャレンジする Advent Calendar 2022 の 17日目の記事です。

内容は、以下でツイートもしていた SwitchBot の新バージョンAPI（v1.1）の話と、旧バージョンAPI の話です。

過去に SwitchBot 関連で書いた記事

今回の話は、SwitchBot 製品を、専用アプリからではなく自分が書いたプログラムから扱う話です。
そういった方向性の話については、過去に BLE を使った方法の記事を書いたことがありました。

今回は、上記のような近接通信ではなく、Web経由の API を使ったものという内容になります。

SwitchBot の新バージョンAPI v1.1

SwitchBot の新バージョンAPI v1.1 に関する公式情報の概要

この新API の話が出たのは、どうやら 2ヶ月前くらいの話のようでした。

●【API】新バージョンAPI v1.1を公開しました - SwitchBot Magazine | スマートホームで暮らしをシンプルに
　https://blog.switchbot.jp/announcement/api-v1-1/

上記の記事の冒頭には、GitHub へのリンクがあったりします。

●OpenWonderLabs/SwitchBotAPI: SwitchBot Open API Documents
　https://github.com/OpenWonderLabs/SwitchBotAPI

自分が所有している SwitchBot製品と新API での対応状況

ここで API関連の話から、いったん自分が所有している SwitchBot製品の話へ（自分のメモも兼ねて）。

だいたい Amazon で買っているので、購入履歴からピックアップしてみます。

先ほどの公式ページのリストの中では、以下があるという状況です。

持っているものは、全て新API で扱えそうな感じです。

SwitchBot の新バージョンAPI v1.1 に関する公式情報の詳細

さらに、新API の公式情報を見てみます。

APIトークンを取得

API を利用するためのトークンが必要で、それは SwitchBot のアプリで取得する形です。以下に記載があります。

スマホの公式アプリでログインした状態まで進め、そこから、アプリ右下の「プロフィール」を押し、「設定」を選んでから出てくるメニュー内の「アプリバージョンを 10回タップ」という操作を行います。

この操作を行うと、以下の画面がアプリ上で見られるようになります。

API v1.1 の使い方を見ていく

新バージョンAPI の使い方を見ていきます。

こちらは、「Authentication」の項目。

https://github.com/OpenWonderLabs/SwitchBotAPI#authentication

どうやら、新API では、トークンとシークレットキーを使って、ユニークなシグネチャ（署名）を生成する必要があるようです。

API v1.1 をプログラムから利用する際のサンプルのプログラムも掲載されていました。いくつかの言語の事例が書かれていますが、自分が使いそうな JavaScript のものを掲載してみます。

const token = "yourToken";
const secret = "yourSecret";
const t = Date.now();
const nonce = "requestID";
const data = token + t + nonce;
const signTerm = crypto.createHmac('sha256', secret)
    .update(Buffer.from(data, 'utf-8'))
    .digest();
const sign = signTerm.toString("base64");
console.log(sign);

const body = JSON.stringify({
    "command": "turnOn",
    "parameter": "default",
    "commandType": "command"
});
const deviceId = "MAC";
const options = {
    hostname: 'api.switch-bot.com',
    port: 443,
    path: `/v1.1/devices/${deviceId}/commands`,
    method: 'POST',
    headers: {
        "Authorization": token,
        "sign": sign,
        "nonce": nonce,
        "t": t,
        'Content-Type': 'application/json',
        'Content-Length': body.length,
    },
};

const req = https.request(options, res => {
    console.log(`statusCode: ${res.statusCode}`);
    res.on('data', d => {
        process.stdout.write(d);
    });
});

req.on('error', error => {
    console.error(error);
});

req.write(body);
req.end();