API.md

Somfy API v1.0.0

Somfy Home Protect Rest API

• Device
  • Get device detail
  • Get site devices
• Security
  • Get the current security level
  • Set the security level
• Site
  • Get site detail
  • List your registered sites
  • List your registered sites in a pretty way

---

Device

Get device detail

Back to top

GET /site/:siteId/device/:deviceId

Parameters - Parameter

Name	Type	Description
siteId	String	Site ID.
deviceId	String	Device ID.

Success response

Success response - Success 200

Name	Type	Description
devices	Object	A Device object

Get site devices

Back to top

GET /site/:siteId/device

Parameters - Parameter

Name	Type	Description
siteId	String	Site ID.

Success response

Success response - Success 200

Name	Type	Description
devices	Object	A Device list object

Security

Get the current security level

Back to top

GET /site/:siteId/security/state

Parameters - Parameter

Name	Type	Description
siteId	String	Site ID.

Success response

Success response - Success 200

Name	Type	Description
level	String	Security level in 'disarmed'

Set the security level

Back to top

GET /site/:siteId/security/:level

Parameters - Parameter

Name	Type	Description
siteId	String	Site ID.
level	String	Security level in 'disarmed'

Success response

Success response - Success 200

Name	Type	Description
status	Object	A Status object

Site

Get site detail

Back to top

GET /site/:siteId

Parameters - Parameter

Name	Type	Description
siteId	String	Site ID.

Success response

Success response - Success 200

Name	Type	Description
site	Object	A site object

List your registered sites

Back to top

GET /site

Success response

Success response - Success 200

Name	Type	Description
sites	Object[]	A site list

List your registered sites in a pretty way

Back to top

GET /sitepretty

Success response

Success response - Success 200

Name	Type	Description
sites	Object[]	A site list