Getting Started¶

1. Log in to API Manager. To access API Manager you need to have API Manager Basic or API Manager Advanced role.

2. Go to Machine Users and create a new machine user with user groups access based on the APIs you need:

   Role	API Access	Access Level
   Operations API Machine User Read	Operations API	Read
   Operations API Machine User Read+Write	Operations API	Read + Write
   Structure API Machine User Read	Structure API	Read
   Structure API Machine User Read+Write	Structure API	Read + Write
   Point Value Ingest API Machine User Write	Point Value Ingest API	Write
   Geometry API read	Geometry API	Read
   Geometry API read+write	Geometry API	Read + Write
   Energy API Machine User Read	Energy API	Read
   Sustainability API Machine User Read	Sustainability API	Read
   Identities & Privileges API read	Identities & Privileges API	Read
   Identities & Privileges API read+write	Identities & Privileges API	Read + Write
   Activities API read	Activities API	Read
   Security Workflows API read & write	Security Workflows API	Read + Write
   Security Monitoring API read	Security Monitoring API	Read
   Visitor Manager API read & write	Visitor Manager API	Read + Write
   Intrusion API Machine User Read+Write	Intrusion API	Read + Write

3. Note down the clientId and clientSecret.

You can use our sandbox environment in a read-only mode to explore the APIs:

1. Request access via the developer dashboard. Credentials are granted immediately.
2. View your credentials on the My Credentials page. Note down the clientId and clientSecret.

1. In the API Manager go to the API documentation page, select your machine user and partition, then generate the token by providing the client secret key.
2. You are ready to call the APIs! Select the APIs of interest from the navigation below and try out your first calls.

Use your clientId and clientSecret to request an authorization token:

export CLIENT_ID=<YOUR_CLIENT_ID>
export CLIENT_SECRET=<YOUR_CLIENT_SECRET>

curl https://siemens-bt-015.eu.auth0.com/oauth/token \
  -H 'content-type: application/json' \
  -d "{
        \"client_id\": \"$CLIENT_ID\",
        \"client_secret\": \"$CLIENT_SECRET\",
        \"audience\": \"https://horizon.siemens.com\",
        \"grant_type\": \"client_credentials\"
      }"

If the request is successful, you will receive a response like this:

{
  "access_token": "eyJ0eXAiOiUSJ9.eyJpc3MiOiJdGlhbHMifQ.MJpcxLfyOt",
  "token_type": "Bearer",
  "expires_in": 86400
}