Developer Portal for Smart Buildings

Welcome IP cloud API concepts

Welcome IP cloud API model

The ABB-Welcome IP door entry systems connect to the ABB-cloud and send all state changes to the cloud. The welcome IP API provides endpoints to request the current configuration or data model. Additional endpoints allow to get and set datapoints which represent the current state of the devices in your door entry system.
With a WebSocket connection or using a WebHook the application can be informed about changes to the model or datapoints without polling.

Data model

The data model consists of the different ABB-Welcome IP door entry systems (also called SmartAP) that are registered for the same ABB-myBuildings Account. The SmartAPs are identified by their UUID. Most endpoints return a JSON-Object where the SmartAP-UUID is the key for the response object from this SmartAP.
A simplified response from the configuration endpoint looks like this:

{
  "data": {
    "SystemWIP": [
      {
        "dtId": "592c91f0-8d9b-44bf-88da-23fd1ef6d994",
        "Assets": [
          {
            "dtId": "592c91f0-8d9b-44bf-88da-23fd1ef6d994_Device_101807A7F02809C",
            "label": "OS 002-01",
            "nameId": "WIP_0801",
            "Channels": [
              {
                "dtId": "592c91f0-8d9b-44bf-88da-23fd1ef6d994_Device_101807A7F02809C_Channel_0",
                "outputs": [
                  {
                    "key": "0",
                    "value": {
                      "id": "0",
                      "value": "8"
                    }
                  }
                ],
                "inputs": [
                  {
                    "key": "0",
                    "value": {
                      "id": "0",
                      "value": "0"
                    }
                  }
                ]
              },
              {
                "dtId": "592c91f0-8d9b-44bf-88da-23fd1ef6d994_Device_101807A7F02809C_Channel_1",
                "outputs": [
                  {
                    "key": "0",
                    "value": {
                      "id": "0",
                      "value": "0"
                    }
                  }
                ],
                "inputs": [
                  {
                    "key": "0",
                    "value": {
                      "id": "0",
                      "value": "0"
                    }
                  }
                ]
              },
              {
                "dtId": "592c91f0-8d9b-44bf-88da-23fd1ef6d994_Device_101807A7F02809C_Channel_2",
                "outputs": [
                  {
                    "key": "0",
                    "value": {
                      "id": "0",
                      "value": "8"
                    }
                  }
                ],
                "inputs": null
              }
            ]
          }
        ]
      }
    ]
  }
}

In this shortened example you see:

• There is a single SmartAP sending its data model.
• That model consists of devices (here only one). A device in the data model matches a real hardware device that is connected to the SmartAP, for example an outdoor station device.
• The device consists of channels. A channel represents some kind of function of the device, such as “door opener, that can be controlled separately. Some devices have multiple channels which may be mutually exclusive, depending on the device.
• Each channel is made of input and output datapoints. A datapoint represents some kind of data that can be sent to the device (input datapoint), such as “door opener”, or that can be read from the device (output datapoint), such as “door is currently on/off.
  See the section on References for details.