Getting Started¶
The Siemens Building X APIs enable you to get up-to-date information from your building. To use our APIs, you need a Siemens Building X account and a connected building, or you can try out APIs using our sandbox environment.
Are you interested in a customer account or in connecting your building? Contact Siemens Regional Support.
Sandbox environment¶
If you don't have a customer account, you can still try out our APIs by requesting access to our sandbox environment. By doing so, you will be granted API credentials with read-only permissions.
Once you obtain the credentials, you can start calling our APIs directly from the Developer Portal by going to our try-out page.
API Manager¶
Do you already have a customer account and a connected building? Then:
- Log in to API Manager.
- Go to Machine Users and create a new machine user. Make sure to note down your
clientId
andclientSecret
. You also have the option to make note of one or morepartitionId
s that you want to use later. - Now you are ready to proceed! Refer to Create a Token to learn how to create a token, or navigate to one of our APIs to find out more.
If you want to dynamically discover the Partitions your machine user has access to, please refer to the Accounts API Quick Start Guide.
Note
You need to have the role Company Administrator
to perform the above steps. If you cannot see the Machine Users menu, contact the administrator in your organization to help you perform the steps.