Realtime (Webhook) API

The smart-me Realtime (Webhooks) API allows you to subscribe to new data of a device. You can subscripe to a single device or to all devices of a user. When a device sends new data to the cloud, a webhook sends this data as a POST request to a preconfigured URL.

Performance considerations

A single device can send it's data up to once a second. If you subscripe for a larger number of devices get sure that your API can handle this load.

Receiving a webhook notification

Creating a webhook endpoint on your server is no different from creating any page on your website. Webhook data is send as serialized protobuffer string in the POST request body.

Endpoint sample

ASP.net WEB API 
public class RealtimeApiController : ApiController
{
   public void Post(DeviceDataArray dataArray)
   {
      foreach (var item in dataArray.DeviceDataItems)
      {
        // do something
      }
   }
}
                      
[ProtoContract]
public class DeviceDataArray
{
    [ProtoMember(1, IsRequired = true)]
    public DeviceData[] DeviceDataItems { get; set; }
}
                      
[ProtoContract]
public class DeviceData
{
    [ProtoMember(1, IsRequired = true)]
    public Guid DeviceId { get; set; }

    [ProtoMember(2, IsRequired = true)]
    public DateTime DateTime { get; set; }

    [ProtoMember(3, IsRequired = true)]
    public DeviceValue[] DeviceValues { get; set; }
}
               
[ProtoContract]
public class DeviceValue
{
    /// http://wiki.smart-me.com/index.php/Obis_codes
   [ProtoMember(1, IsRequired = true)]
   public byte[] Obis { get; set; }

   [ProtoMember(2, IsRequired = true)]
   public double Value { get; set; }
}

Include Protobuffer into project: https://damienbod.com/2014/01/11/using-protobuf-net-media-formatter-with-web-api-2/

Test your Server API Implementation