BoschSmartHome / bosch-shc-api-docs

Bosch Smart Home Controller Local REST API
Other
208 stars 44 forks source link

Outdated API Version #58

Closed fubian closed 2 years ago

fubian commented 2 years ago

This repository seems to support API version 2.1 only. The public information of my Bosch Smart Home Controller shows me, that it runs on API version 2.5:

{
    "apiVersions": [
        "2.5"
    ],
    "softwareUpdateState": {
        "@type": "softwareUpdateState",
        "swUpdateState": "NO_UPDATE_AVAILABLE",
        "swUpdateLastResult": "UPDATE_SUCCESS",
        "swUpdateAvailableVersion": "",
        "swInstalledVersion": "10.4.2272-21994",
        "swActivationDate": {
            "@type": "softwareActivationDate",
            "timeout": 604800000
        }
    },
    "macAddress": "xxx",
    "claimed": true,
    "country": "DEU",
    "tacVersion": "DEU-12",
    "shcIpAddress": "xxx",
    "clientIds": [
        "xxx",
        "xxx",
        "xxx"
    ],
    "featureToggles": {
        "app-store-rating.ios": true,
        "protect-plus.fuchsia": false,
        "homekit-twinguardvoc": false,
        "psm.pc.pairing": true,
        "smart-light.pairing": true,
        "homekit-bwth": false,
        "wls.pairing": true,
        "shading.advance.menu": true,
        "analytics.toggle.bronze": true,
        "outdoor-siren.pairing.ebony": true,
        "smlo.release": true,
        "app-store-rating.android": true,
        "homekit-plugcompact": false,
        "cloud.tokenvalidation": true
    },
    "connectivityVersions": [
        {
            "name": "claiming",
            "minVersion": 1,
            "maxVersion": 1
        },
        {
            "name": "noncePairing",
            "minVersion": 1,
            "maxVersion": 1
        },
        {
            "name": "buttonPairing",
            "minVersion": 1,
            "maxVersion": 1
        }
    ]
}

I suspect this as the root cause for the problem, that I cannot register a new device following the steps described in the Postman Collection:

{
    "@type": "JsonRestExceptionResponseEntity",
    "errorCode": "PROPERTY_VALIDATION_FAILED",
    "statusCode": 400
}

Could this issue be caused due to the mismatch of API version numbers or do I miss any important step here?

sebastianharder commented 2 years ago

This repo contains only the public part of the REST API. There are more endpoints solely being used by the original Bosch Smart Home app, such as for example modifying automations. Whenever we do a forward-compatible change to either the public or internal APIs, the API version gets a higher minor version. So, in general, it's absolutely normal that the API version in this repo lacks behind the Smart Home Controller. But it could also be that we did not find the time yet to update the repo here.

What is the request, you are trying to send?

sebastianharder commented 2 years ago

Closing due to inactivity.