キーパッドに対して createKey コマンド（パスコード生成）を実行した際、レスポンスの body 内に、生成されたパスコードの id（Key ID）を含めて返却していただきたい

[plaisirrental-hash]

Analysis

いつもSwitchBot製品とAPIを利用させていただいております。 現在、API v1.1を利用して「キーパッド（Keypad）」および「指紋認証パッド（Keypad Touch）」のパスコード管理システムを開発しておりますが、仕様に関して1点、至急の改善要望がございます。

【要望内容】 キーパッドに対して createKey コマンド（パスコード生成）を実行した際、レスポンスの body 内に、生成されたパスコードの id（Key ID）を含めて返却していただきたいです。

【現状の課題】 現在、createKey コマンドを実行すると、以下のように body が空の状態で返ってきます。
JSON

// 現在のレスポンス
{
"statusCode": 100,
"body": {}, // <--- ここが空です"message": "success"
}

一方で、パスコードを削除するコマンド deleteKey を実行するには、パラメータとして id (Key ID) が必須となっています。 しかし、作成時（createKey）に id が返却されず、また「現在登録されているパスコード一覧を取得するAPI」も存在しないため、API経由で作成したパスコードを、API経由で削除するための id を知る術がありません。

【解決したいユースケース】 宿泊予約システム等において、以下のフローを実現したいと考えています。

予約確定時に、期間限定パスコードを発行する（createKey）。

予約がキャンセルされた場合、そのパスコードを即座に削除する（deleteKey）。

現状ではIDが取得できないため、2の削除処理が自動化できません。

【期待するレスポンス】 以下のように、割り当てられたIDを返してください。
JSON

{
"statusCode": 100,
"body": {
"id": 12, // <--- このIDが必要です"passcode": "123456" // (可能であれば)
},
"message": "success"
}

APIの利便性向上のため、ご検討いただけますと幸いです。 よろしくお願いいたします。

Expected Behavior

いつもSwitchBot製品とAPIを利用させていただいております。 現在、API v1.1を利用して「キーパッド（Keypad）」および「指紋認証パッド（Keypad Touch）」のパスコード管理システムを開発しておりますが、仕様に関して1点、至急の改善要望がございます。

【要望内容】 キーパッドに対して createKey コマンド（パスコード生成）を実行した際、レスポンスの body 内に、生成されたパスコードの id（Key ID）を含めて返却していただきたいです。

【現状の課題】 現在、createKey コマンドを実行すると、以下のように body が空の状態で返ってきます。
JSON

// 現在のレスポンス
{
"statusCode": 100,
"body": {}, // <--- ここが空です"message": "success"
}

一方で、パスコードを削除するコマンド deleteKey を実行するには、パラメータとして id (Key ID) が必須となっています。 しかし、作成時（createKey）に id が返却されず、また「現在登録されているパスコード一覧を取得するAPI」も存在しないため、API経由で作成したパスコードを、API経由で削除するための id を知る術がありません。

【解決したいユースケース】 宿泊予約システム等において、以下のフローを実現したいと考えています。

予約確定時に、期間限定パスコードを発行する（createKey）。

予約がキャンセルされた場合、そのパスコードを即座に削除する（deleteKey）。

現状ではIDが取得できないため、2の削除処理が自動化できません。

【期待するレスポンス】 以下のように、割り当てられたIDを返してください。
JSON

{
"statusCode": 100,
"body": {
"id": 12, // <--- このIDが必要です"passcode": "123456" // (可能であれば)
},
"message": "success"
}

APIの利便性向上のため、ご検討いただけますと幸いです。 よろしくお願いいたします。

Steps To Reproduce

いつもSwitchBot製品とAPIを利用させていただいております。 現在、API v1.1を利用して「キーパッド（Keypad）」および「指紋認証パッド（Keypad Touch）」のパスコード管理システムを開発しておりますが、仕様に関して1点、至急の改善要望がございます。

【要望内容】 キーパッドに対して createKey コマンド（パスコード生成）を実行した際、レスポンスの body 内に、生成されたパスコードの id（Key ID）を含めて返却していただきたいです。

【現状の課題】 現在、createKey コマンドを実行すると、以下のように body が空の状態で返ってきます。
JSON

// 現在のレスポンス
{
"statusCode": 100,
"body": {}, // <--- ここが空です"message": "success"
}

一方で、パスコードを削除するコマンド deleteKey を実行するには、パラメータとして id (Key ID) が必須となっています。 しかし、作成時（createKey）に id が返却されず、また「現在登録されているパスコード一覧を取得するAPI」も存在しないため、API経由で作成したパスコードを、API経由で削除するための id を知る術がありません。

【解決したいユースケース】 宿泊予約システム等において、以下のフローを実現したいと考えています。

予約確定時に、期間限定パスコードを発行する（createKey）。

予約がキャンセルされた場合、そのパスコードを即座に削除する（deleteKey）。

現状ではIDが取得できないため、2の削除処理が自動化できません。

【期待するレスポンス】 以下のように、割り当てられたIDを返してください。
JSON

{
"statusCode": 100,
"body": {
"id": 12, // <--- このIDが必要です"passcode": "123456" // (可能であれば)
},
"message": "success"
}

APIの利便性向上のため、ご検討いただけますと幸いです。 よろしくお願いいたします。

Logs

いつもSwitchBot製品とAPIを利用させていただいております。 現在、API v1.1を利用して「キーパッド（Keypad）」および「指紋認証パッド（Keypad Touch）」のパスコード管理システムを開発しておりますが、仕様に関して1点、至急の改善要望がございます。

【要望内容】 キーパッドに対して createKey コマンド（パスコード生成）を実行した際、レスポンスの body 内に、生成されたパスコードの id（Key ID）を含めて返却していただきたいです。

【現状の課題】 現在、createKey コマンドを実行すると、以下のように body が空の状態で返ってきます。
JSON

// 現在のレスポンス
{
    "statusCode": 100,
    "body": {},  // <--- ここが空です"message": "success"
}

一方で、パスコードを削除するコマンド deleteKey を実行するには、パラメータとして id (Key ID) が必須となっています。 しかし、作成時（createKey）に id が返却されず、また「現在登録されているパスコード一覧を取得するAPI」も存在しないため、API経由で作成したパスコードを、API経由で削除するための id を知る術がありません。

【解決したいユースケース】 宿泊予約システム等において、以下のフローを実現したいと考えています。

    予約確定時に、期間限定パスコードを発行する（createKey）。

    予約がキャンセルされた場合、そのパスコードを即座に削除する（deleteKey）。

現状ではIDが取得できないため、2の削除処理が自動化できません。

【期待するレスポンス】 以下のように、割り当てられたIDを返してください。
JSON

{
    "statusCode": 100,
    "body": {
        "id": 12,  // <--- このIDが必要です"passcode": "123456" // (可能であれば)
    },
    "message": "success"
}

APIの利便性向上のため、ご検討いただけますと幸いです。 よろしくお願いいたします。

Configuration

いつもSwitchBot製品とAPIを利用させていただいております。 現在、API v1.1を利用して「キーパッド（Keypad）」および「指紋認証パッド（Keypad Touch）」のパスコード管理システムを開発しておりますが、仕様に関して1点、至急の改善要望がございます。

【要望内容】 キーパッドに対して createKey コマンド（パスコード生成）を実行した際、レスポンスの body 内に、生成されたパスコードの id（Key ID）を含めて返却していただきたいです。

【現状の課題】 現在、createKey コマンドを実行すると、以下のように body が空の状態で返ってきます。
JSON

// 現在のレスポンス
{
    "statusCode": 100,
    "body": {},  // <--- ここが空です"message": "success"
}

一方で、パスコードを削除するコマンド deleteKey を実行するには、パラメータとして id (Key ID) が必須となっています。 しかし、作成時（createKey）に id が返却されず、また「現在登録されているパスコード一覧を取得するAPI」も存在しないため、API経由で作成したパスコードを、API経由で削除するための id を知る術がありません。

【解決したいユースケース】 宿泊予約システム等において、以下のフローを実現したいと考えています。

    予約確定時に、期間限定パスコードを発行する（createKey）。

    予約がキャンセルされた場合、そのパスコードを即座に削除する（deleteKey）。

現状ではIDが取得できないため、2の削除処理が自動化できません。

【期待するレスポンス】 以下のように、割り当てられたIDを返してください。
JSON

{
    "statusCode": 100,
    "body": {
        "id": 12,  // <--- このIDが必要です"passcode": "123456" // (可能であれば)
    },
    "message": "success"
}

APIの利便性向上のため、ご検討いただけますと幸いです。 よろしくお願いいたします。

Environment

• OS:
• Software:
• Node:
• npm:

Additional Context

No response