Getting Started¶
The Siemens Building X APIs enable you to retrieve up-to-date information from your building. To use our APIs, depending on whether you already have a customer account or not, you can either go directly to the Building X API Manager, or try out the APIs using our sandbox environment and Developer Portal.
Are you interested in obtaining a customer account or connecting your building? Contact Siemens Regional Support.
API Manager¶
If you already have a customer account and a connected building:
- Log in to API Manager.
- Go to the Machine Users page and create a new machine user. Ensure that your machine user has the correct user groups assigned. Note down your
clientId
andclientSecret
. - Go to the API documentation page, select your machine user and partition, then generate the token by providing the client secret key.
- You are ready to call the APIs! Select the APIs of interest from the navigation and try out your first calls.
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.
Sandbox environment¶
If you don't have a customer account, you can still try out our APIs:
- Request access via the developer dashboard to our sandbox environment. The credentials are granted immediately and you can inspect them on the My Credentials page.
- Once you obtain the credentials, refer to the Authentication page to learn how to obtain an authorization token.
- To start calling our APIs directly from the Developer Portal, go to our try-out page. Click the "Authorize" button to enter your token and start testing the APIs.
Note
Currently, the Fire and LifecycleTwin APIs are not part of the sandbox environment. Please use Contact Us to request access.