Third-party integration

Terminology

Application Programming Interface (API)

An Application Programming Interface (API) is an HTTP server endpoint that System A listens to. A third-party, System B, can then perform HTTP requests towards that API endpoint to extract information from System A, in a request-reply on-demand fashion.

Webhook

An outbound HTTP request that System A makes to System B. This is used in setups where it’s desirable that System B gets updated with information from System A, in an event-driven fashion, e.g. when information has been updated in System A.

Deeplink

In web applications, a deeplink is a URL that directs users to a specific page or piece of content within an application, rather than just the homepage of the application. This can provide significant opportunities in terms of integration and engagement. For example:

• Direct access: Instead of navigating through the application's menus, users can go directly to specific content, enabling them to access relevant information quickly.

• Sharing: Thanks to the nature of them, deeplinks make it easier to share specific content with another user in the application.

Deeplinks

YourSixOS provides deeplinks to allow a third-party system to link into The Matrix. Links will auto-populate an ad-hoc Matrix view and start live streaming or playback of recorded material.

The following functionalities are available through deep linking:

• Play live from the first 20 video sources of a specified site:

  /matrix/autoplay/organization/ORGANIZATION-ID/site/SITE-ID

• Play video devices. If no timestamp is provided, it plays live:

  /matrix?deviceIds=DEVICE-ID-1,DEVICE-ID-2&timestamp=TIMESTAMP-IN-SECONDS

• Play video sources. If no timestamp is provided, it plays live:

  /matrix?deviceIds=DEVICE-ID-1_SOURCE-ID-1,DEVICE-ID-2_SOURCE-ID-2&timestamp=TIMESTAMP-IN-SECONDS

• Play from the first 20 video sources of a specified alarm group. If no timestamp is provided, it plays live:

  /matrix?alarmGroupId=<alarmGroupId>&timestamp=<timestamp in seconds>

INFO

All of the links are relative to the web application base URL (https://platform.yoursix.com).

Event notification webhooks

YourSixOS provides HTTP webhooks as a recipient of event notifications.

These notifications are security events sent to a designated receiver. Receivers can include users via email, organization email addresses, or webhook receivers. Examples of security events include motion detection and barrier forced open. Similar to how YourSixOS can send notifications to mobile devices, it can also notify third-party services via webhooks. For more details about the contents of these webhooks, check out the events concept

INFO

Check out our Github for integration examples.

Central station integration

YourSixOS can send dedicated HTTP webhooks to central stations in order to raise alarms in the central station software. In addition to the central station webhooks, YourSixOS also offers a dedicated HTTP API for central stations.

The central station integration suite is granted only to strategic integration partners. For more information, reach out to your account representative.

For more information on central station integration, read the dedicated article.

Source code examples

Please check out our Github to find examples on how to write integrations with YourSixOS.