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 an customer account or in connecting your building? Contact Siemens Regional Support.

Sandbox environment¶

If you don't have the customer account you can still try out our APIs by requesting access to our sandbox environment. By that you will be granted API credentials with read-only permissions.

When you obtain the credentials you can start calling our APIs directly from Developer Portal by going to our try out page.

API Manager¶

Do you already have an customer account and a building connected? Then:

1. Login to API Manager.
2. Go to Machine Users and create a new machine user. Make sure to note down your clientId and clientSecret. You also have the option to make note of one or more partitionIds that you want to use later.
3. 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.