Getting started with the SwissHomeguard API

Welcome to the SwissHomeguard API site

This guide explains how to access the SwissHomeguard API, how authorization works, and which system functions can be integrated.

The API is designed for secure, system-specific integrations.

Within this site you will find comprehensive guides and documentation to help you get started working with the SwissHomeguard API

API Integration

What is the API site

The API allows you to integrate the control of the SwissHomeguard system. This way you enable your customers to easily operate their video surveillance system through your existing software.

Developer Access

How can I use the API?

To get access to the API, you need to register as a developer. After that you can request an API Key for the customers system. To request an API Key, you need the following information:

  • One-Time Passcode
  • System name

You can get this information from the owner of the SwissHomeguard system. He can retrieve it after successful login in his system. A corresponding request is received by Homeguard. Homeguard checks this request afterwards. As soon as the request is approved, you will be notified by mail.

Available functions:

Enable/disable video recording
Control video recording functionality remotely through your software.
Enable/disable alarm central
Manage the alarm central functionality through your integration.
Enable/disable protection plan
Control protection plans and scheduling through the API.
Enable/disable siren (if any)
Trigger or disable sirens when connected to the system.

Future functions:

Integration of live streams
Access and display live video streams from security cameras.
Display of past events
Retrieve and show historical footage and event data.

As soon as you have received your confirmation mail, you can log in here again. You will now have access to your request and the issued API Key. This is only valid for the corresponding system. Each additional system requires a new system-specific API key.

This information can be obtained from the owner of the SwissHomeguard system. After the request has been created, it will be checked and approved by SwissHomeguard. As soon as the approval has been given, we will inform you by email.