The Syscom API connection supports the connection and transfer of vibration sensor data from the Syscom SCS into the iTwin IoT platform. Sensors must already be added to the Syscom application prior to adding them to iTwin IoT. This article will guide the user in setting up the Syscom SCS to iTwin IoT API connection.

 

Setting up Syscom SCS for Data Transfer

To set up the transfer, you must have login access to the SCS application, https://scs-dev.syscom.ch/login. Enter the login credentials when prompted.

 

API Setup

 

1. From the main page, click on the User Options dropdown in the upper right of the page. 

2. Click the "API & Webhooks" option.

 

 

3. Click the "+Create a new API key" button. An API key string will be generated in a green pop-up box. Record this key for later use when establishing the connection to iTwin IoT.

 

 

Webhooks

1. Navigate to the Webhooks tab of the API & Webhooks portal.

 

 

2. Two Webhooks will need to be added. If the "Enable Webhooks" button toggle is not enabled, toggle it on. Start the webhook addition process by clicking on the green "+Add webhook" button. 

3. Webhook 1- In the Add Webhook popout window shown below, configure the first webhook following the screenshot or written step description below.

 

 

A. Webhook Event- Select "RECORD.BACKGROUND_UPLOADED" from the dropdown selection tool.

B. Endpoint URL- Enter or copy and paste the following URL into the input box: https://app.sensemetrics.com/api/push/syscom

C. Format- Select "JSON" from the Format dropdown options.

D. Token- The token field acts as a password that can be used to validate the webhook request. Enter a password of your choosing, but keep this password in your records to establish the connection in iTwin IoT later. Note: The same password token must also be used for the second webhook.

E. Save- Click the Save icon to create the first webhook.

 

4. Webhook 2- Click the "+Add webhook" button again, and configure the second webhook following the screenshot or written step description below.

 

 

A. Webhook Event- Select "RECORD.EVENT_UPLOADED" from the dropdown selection tool.

B. Endpoint URL- Enter or copy and paste the following URL into the input box: https://app.sensemetrics.com/api/push/syscom

C. Format- Select "JSON" from the Format dropdown options.

D. Token- Enter the same password token that was used in creating the first webhook in Step 3D above.

E. Save- Click the Save icon to create the first webhook.

 

Two configured webhooks should now be visible on the Webhooks page.

 

 

Adding Syscom API Connection to iTwin IoT

 

1. Within the iTwin IoT application, begin by navigating to the Connectivity Module.

 

 

2. Click on the "+Connection" icon.

3. Find or scroll to the "Syscom" name on the left of the screen and click on the name. 

4. A Syscom logo will appear in the middle of the screen. Click the blue "Select" button to advance to the next page.

 

 

5. API Key- Retrieve the API key generated in Step 3 of the API token section above and input it into the API Key field.

6. Webhook Token- Retrieve the token created in Step D of the Webhooks section above and input it into the Webhook Token field.

7. Click the "Next" button to advance to the next page.

 

 

8. Click the Apply button to establish the API connection. You will be taken back to the main Connectivity Page.

 

 

Device Selection

Once the connection has been established, the Syscom connection will be visible on the Connectivity page. You can then select the sensor devices from Syscom that you would like to connect to the iTwin IoT asset. 

1. Click on the Syscom connection on the left side of the page to access the Syscom configuration page.

 

 

2. Click on the "Edit Configuration" option on the left side of the page.

 

 

 3. Enabling Devices- Within the "Edit Configuration" page, new options will be available for you to toggle the sensor devices from Syscom's application that you want to see visible in this iTwin IoT asset. Toggling the switch on by clicking will turn it green, and when settings are saved, the sensor devices toggled on will be visible within the Connectivity Module homepage.

4. Once devices have been toggled on, save the changes by clicking the blue "Apply" button. This will bring you back to the main Connectivity page. 

 

 

Once back in the main Connectivity page, you will be able to see all devices toggle on in the previous step on the right side of the Connectivity page, as illustrated below. New and historic data will not begin to stream into iTwin IoT until a new reading is taken and pushed from Syscom to iTwin IoT.