Bosch IoT Things HTTP API

Details regarding the syntax can be found in following sections and at the REST-like HTTP API description application itself.

The interactive API documentation supports you to instantly try it out.
In order to try it out please start by booking a free plan - see Book the Bosch IoT Things cloud service.
Please request a service plan as you will definitely need an identifier for each single API call.

Navigate to https://apidocs.bosch-iot-suite.com and select Bosch IoT Things - API v2 at the upper right drop-down-menu.

The entry point is https://apidocs.bosch-iot-suite.com

  1. Select a spec: Bosch IoT Things - API v2
    (in case you need to work with version 1 see Previous versions)
  2. Servers:
    This field shows the service endpoint, which differs depending on which environment you subscribed for:
    1. For the Bosch IoT Cloud infrastructure this is:
      https://things.s-apps.de1.bosch-iot-cloud.com/api/2
    2. For the Amazon Web Services infrastructure this is:
      https://things.eu-1.bosch-iot-suite.com/api/2


      Find the list of all endpoints at our FAQ section Environment.

  3. Authorize - opens a pop-up-dialog with multiple options:
    1. Things API Token (API Key):
      • If you act as a user, the API token must additionally be set, otherwise the Things service will not know that you are a legitime customer.
        Tip: The API token is not bound to a user account, nor to any thing entity representing a device, but can be used for any application interaction with our API.
      • Click Authorize.
    2. User authorization - select ONE of the following options:
      • Bosch ID - OAuth2.0
        • Check the respective box in case you want to use your Bosch-ID.
        • Click Authorize.
        • You will be directed to the Bosch login dialog, and then re-directed to the Things service.
      • Basic authentication - for users provided by a Bosch IoT Permsissions instance
        • Set Your-Tenant-Name\Your-Username in the username field,
        • Set the password.
        • Click Authorize.
      • Bearer Auth - JWT - for users provided by one of the external identity providers
        • Set your complete Bearer token in the value field
        • Click Authorize.

While using the Bosch IoT Things HTTP API programmatically you will need:

  1. The header for authenticating your solution as described at Authenticate as a technical client:
    x-cr-api-token=<$your-apiToken>
  2. The header for authenticating the current user as described at Authenticate as a user:
    1. via Basic Auth:
      <$tenant-name>\<$username>=<$password>
    2. or alternatively with a Context ID
      (which holds for example all Groups the user is member of, and all Roles assigned to the user at the time of creating the Identity Context)
      x-im-context-id=<$the context ID>
    3. or alternatively with a JSON Web Token (JWT)
      Authorization=Bearer <$ your token>
  3. The header for specifying the content type, e.g.
    Content-Type=application/json